search

ghmartin77 / SmartLEDLamp

A smart, web-enabled floor lamp with nice visual effects based on IKEA Vidja powered by ESP8266 and WS2801.
MIT License
26 stars 4 forks source link

Add compatibility with the Arduino IDE #2

Closed per1234 closed 6 years ago

per1234 commented 6 years ago

Related: https://github.com/ghmartin77/SmartLEDLamp/issues/1#issuecomment-381403285

per1234 commented 6 years ago

Moving all source files into a subfolder SmartLEDLamp seems reasonable as well on first glance but it hides all relevant files one folder deeper. Is this really necessary?

It's not necessary but it does add an extra step for the typical Arduino user who will want to use the "Download ZIP" option, rather than git clone:

Required steps to use SmartLEDLamp with my current proposal:

Required steps to use SmartLEDLamp if the sketch is not put in a subfolder:

The first set of steps are very familiar and common sense. The user will do all of that instinctively. The need to rename the extracted folder is very much non-intuitive and if that step is not done then a lot of confusion will result.

I'm happy to remove that commit if you don't like that change. In that case I would suggest adding installation instructions, and am happy to do so.

Additionally not putting the data folder into the new SmartLEDFolder as well breaks SPIFFS upload functionality

Sorry for missing that. If you do decide you want to keep the sketch subfolder I'll move the data folder into it.

So just let me know your decision and I'll get this PR fixed up.

ghmartin77 commented 6 years ago

Ok, I'm convinced. Also checked some other Arduino/ESP8266 github project structures and found you're absolutely right. The structure you're proposing is common sense (and it also won't break my Eclipse-based Arduino build environment). Thanks again for pointing that out. Taking you pull request as is and will move the data folder later on.