projects/esp-weather-station
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more structure and guidance

Browse Source 
- contribution guidelines
- GitHub templates
- new paragraph in README
This commit is contained in:
Marcel Stör
2018-04-15 20:29:19 +02:00
parent b154356c33
commit aab7dde9d8
5 changed files with 145 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -10,7 +10,7 @@ ESP8266 Weather Station Color using ILI9341 240x320 TFT display
The code in this project supports an ILI9341 240x320 TFT display with code running on an ESP8266. To get you up and running in no time we created a kit which contains all the necessary parts including a custom PCB to connect display and WiFi chip:
[https://thingpulse.com/product/esp8266-wifi-color-display-kit-2-4/](https://thingpulse.com/product/esp8266-wifi-color-display-kit-2-4/)
By buying the kit from us you are supporting future development. Thank you!
Buy the kit from us to support future development of this application. Thank you!
[![ThingPulse ESP8266 Color Display Kit](resources/ESP8266ColorDisplayKit.png)](https://thingpulse.com/product/esp8266-wifi-color-display-kit-2-4/)
@@ -18,6 +18,14 @@ By buying the kit from us you are supporting future development. Thank you!
A complete step-by-step tutorial/guide is available at [https://docs.thingpulse.com/guides/wifi-color-display-kit/](https://docs.thingpulse.com/guides/wifi-color-display-kit/).
## Licensing, contributions and maintenance
The code in this repository is licensed under [MIT](https://en.wikipedia.org/wiki/MIT_License), a short and simple permissive license with conditions only requiring preservation of copyright and license notices. Thus, you're free to fork the project and use the code for your own projects as long as you keep the copyright notices in place.
ThingPulse is committed to open-source development and will continue to maintain this code. We welcome contributions from the community given they are roughly in line with our [guidelines](CONTRIBUTING.md). However, please understand that we primarily developed this application to be run on our own hardware kit mentioned above. It's the only platform we regularly test the code against. You are of course free to run the code on any hardware you think is compatible but you have to rely on community support should you run into problems.
ThingPulse runs a support forum for its customers that is better suited to answering user questions than the issues list here.
## Wiring
The below wiring diagram is only needed when you do _not_ buy the self-contained kit from ThingPulse but rather assemble the components yourself.