Mod descriptions should be defined in README.md

A place to talk about the official Factorio mod portal (https://mods.factorio.com)
User avatar
slikts
Burner Inserter
Burner Inserter
Posts: 13
Joined: Mon Apr 11, 2016 2:13 pm
Contact:

Mod descriptions should be defined in README.md

Post 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
ChrislyBear
Burner Inserter
Burner Inserter
Posts: 14
Joined: Thu Jul 05, 2018 7:46 am
Contact:

Re: Mod descriptions should be defined in README.md

Post by ChrislyBear »

Sorry to revive this thread, but

+1!
User avatar
eradicator
Smart Inserter
Smart Inserter
Posts: 5207
Joined: Tue Jul 12, 2016 9:03 am
Contact:

Re: Mod descriptions should be defined in README.md

Post 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.
Author of: Belt Planner, Hand Crank Generator, Screenshot Maker, /sudo and more.
Mod support languages: 日本語, Deutsch, English
My code in the post above is dedicated to the public domain under CC0.
Post Reply

Return to “Mod portal Discussion”