Improve README - Githubissues

srg74 / WLED-wemos-shield

Wemos D1 Mini (ESP8266) or Wemos ESP32 D1 Mini (ESP32) based universal shield for WLED firmware

https://github.com/srg74/WLED-wemos-shield

MIT License

501 stars 69 forks source link

Improve README #45

Closed CWempe closed 3 years ago

CWempe commented 3 years ago

It has been a long time since I setup this shiled with WLED . :) So took me a few minutes to get it working again this time.

My issues were:

I was not sure what pins are used by this shield.
I guessed correct it uses the default pins
I forgot to set the relay pin. So the LEDs stayed off at first.

Maybe this information should be added to the README.

srg74 commented 3 years ago

Actually all pins are described in schematic. Pinout available for esp8266 and esp32 boards.

CWempe commented 3 years ago

I knew I could look for the pins in the schematic or the pcb design.

I just think it would make it easier for the average user if they were mentioned in the README. Or maybe a short sentence with a link to the schematic.

just my 2 cents 😉

srg74 commented 3 years ago

You absolutely correct. For average user it have to be pointed. Project in constant development and better more clearer navigation in plans.