Coder Social home page Coder Social logo

Comments (5)

ba58smith avatar ba58smith commented on May 30, 2024

I really like having the program as close as possible to usable by a new user, after cloning it from GitHub, so having a platformio.ini that already knows how to work with some of the most common ESP's (Wemos D1 Mini, etc.) is important. Then the README can provide very basic instructions for specifying which of those a new user is using, and it should just work. I've see a few PR's that have included such a platformio.ini, but we haven't merged any of them yet. They have a section for all of the settings necessary regardless of the board, then a section for each board's settings, and all it takes is one change to make it work with any of the boards. (https://github.com/SignalK/SensESP/blob/149aeb921dccdac1f7e37143099f06d614d0ddd8/platformio.ini)
I'm all in favor of adapting something like this, and then making it "off limits" for developers unless it's done as a separate PR specifically for adding support for another board.

from sensesp.

KEGustafsson avatar KEGustafsson commented on May 30, 2024

If you add platformio.ini to .gitignore -file, then PRs would not contain it. Modifications to main platformio.ini could be done from webui. With git cloning, you'll get ini-file.

It would be nice to have as many platforms included to ini-file and default could be Wemos D1 mini as it is now.

from sensesp.

mairas avatar mairas commented on May 30, 2024

@KEGustafsson that would be an ideal solution but I don't think you can ignore files already tracked by git. And yes, quick testing unfortunately verified that.

OTOH, if @ba58smith thinks this really isn't an issue, maybe we could just live with it?

from sensesp.

ba58smith avatar ba58smith commented on May 30, 2024

@mairas - Currently, you and I are the only ones merging PR's. If we just don't allow platformio.ini to be included in any PR, except a PR specifically done to update the default platformio.ini - would that work, at least for now?

from sensesp.

mairas avatar mairas commented on May 30, 2024

@mairas - Currently, you and I are the only ones merging PR's. If we just don't allow platformio.ini to be included in any PR, except a PR specifically done to update the default platformio.ini - would that work, at least for now?

I'm sure it would. But to be precise, I only want to avoid accidental updates. Improvements and other conscious modifications are fair game, as long as their impact is considered!

On the other side of the scale is your point that there should be a default platformio.ini file in place. Given that it's likely that more people download and build the source than make PRs, ease of getting started should be our priority. I'll just close this issue!

from sensesp.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.