search

duxenmx / E_ink_dashboard

E_paper display using raspberry pi zero showing realtime information of several topics, like weather, transit, currencies, stocks, tasklist and meetings
MIT License
70 stars 6 forks source link

Update your Markdown in the readme. #2

Closed GoodClover closed 4 years ago

GoodClover commented 4 years ago

Hi I have fixed up some of you markdown in your readme. Here's the changes:

  1. The sub-headings should use ## heading2 rather than being made bold with **heading2**
  2. Lists need a space after the -, However I have removed a few of these as they seemed better to me as paragraphs.
  3. Fixed some links, they cannot have a space between the ](, e.g. [hello](https://www.example.com)
  4. Any code should be surrounded with `

For an excellent Markdown introduction I recommend you look at https://learnmarkdown.com/ :)

I also added a note about this requiring PIL/Pillow.

duxenmx commented 4 years ago

thanks!