Page 1 of 1

Mod descriptions should be defined in README.md

Posted: Sun May 10, 2020 3:15 pm
by slikts
Mod descriptions should work the same way as GitHub and other similar repos: they should be defined by a README.md file at the root of the mod directory. It would be a small change, particularly because the format for the descriptions is already Markdown, but would have the following significant benefits:
  • The description would have version history
  • It could be edited using your regular code editor instead of the web interface (which doesn't have a preview, for example)
  • The information could also be read offline by someone examining the mod package

Re: Mod descriptions should be defined in README.md

Posted: Thu Oct 08, 2020 9:43 am
by ChrislyBear
Sorry to revive this thread, but

+1!

Re: Mod descriptions should be defined in README.md

Posted: Sat Nov 28, 2020 4:54 pm
by eradicator
+1 conceptually.

But i'd prefer seperate markdown files for info/description/faq etc as suggested here. Especially because readme.md is already used for the github description, which is different from the mod portal description.