search

MakeContributions / markdown-dungeon

This is an example that how to use Markdown creating a dungeon, please give a ⭐
https://markdown-dungeon.netlify.app/
MIT License
321 stars 149 forks source link

Improvising README.md #30

Closed Arsenic-ATG closed 4 years ago

Arsenic-ATG commented 4 years ago

I was thinking🤔 to compress the 📖README.md so that it become easier to read for the users, but I want suggestions on how to do it or should not do it at all.

  1. should I break the main file in multiple file (one for contributing instructions, one for installation instructions etc) and link them in the main readme.md file

  2. orshould I use a drop down menu like this one

  3. or something else....(your suggestion)🤔

ming-tsai commented 4 years ago

Hi @Arsenic-ATG, The seconds one is ok.

Arsenic-ATG commented 4 years ago

@ming-tsai thanks for suggestion I have used that method to compress the readme.md you can see the the changes on my fork to get an rough idea how things will look after changes.

there is still some 🛠formatting left to do before launching a PR.

any suggestions would be appreciated.🙂

Edit: status == completed ✅ created pull request ✅