Log in to reply
 

README format



  • So I've switched back and forth with READMEs because my mod has rather many options. From simple README.txt to word documents to PDF files and now back to a README.md.

    What do you people think is the most convenient? I'll probably just link a README.md on GitHub /w markdown for easy navigation and emphasis, without needing a heavy PDF reader or word processor to read documents. Also allows for easier copy-pasting. Downside is that the readme is not present in the downloaded archive.

    Sample:
    https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/README.md

    Opinions?



  • I'd say that a PDF file would suffice. That's only my opinion though



  • @ikt I wasn't sure until it occurred to me that you can run that doc page through a translator like Google Translate and get it in another language.

    I'd say that makes it a very useful way of distributing the information, especially with a complex mod like yours. It doesn't work directly on the README.md but does work on the page that contains it.



  • Yeah, I could also just export it to PDF. The most important thing is the ability to navigate around using the Table of Contents and some markup (impossible with .txt). It should also be more accessible without a PDF reader, and I don't like the pages thing.

    Also I don't think it's likely somebody can download GTA V and the mod but can't open a browser to look at the readme. Though I have serious doubts the README is actually read by some people anyway.



  • @ikt I don't think some people even read the description all the way through. :)



  • @LeeC2202 When installing vehicle add-ons, I don't even open the Readme. 😂
    But if the Readme is complex, and would require screenshots to explain, pdf format will be great.



  • @Akila_Reigns Oh I know, most of us don't. But I've seen you helping people who have put asi files into their mods folders, so you know the types of people I mean. ;)



  • @LeeC2202 I don't think .md is very familiar with most people. I don't see many people using markdown. But I like the format, so I prefer it.



  • @Akila_Reigns It's not a format I have ever encountered outside of Github, I actually thought it was a Github specific format as part of their project resources. It just look like an HTML page to me, so I don't mind it.

    I just think the idea of something translatable is a good idea with a global modding community. So anything that offers that gets my vote for sure. And as I say, whilst Google won't translate the document itself, if you go to this link: Readme Page, which is the page containing the Readme md file, that can be translated, so it works fine.



  • @LeeC2202 Surprisingly, it is. Click on readme.md it will take you to some website.



  • @Akila_Reigns I've just changed my post to break that link, that site looks iffy. :(



  • Yeah, I now just have a README.txt with a link to the GitHub page. Turks are shit outta luck but what country blocks GitHub anyway.

    I might just generate a .html page if that's more convenient for the users.


Log in to reply
 

Looks like your connection to GTA5-Mods.com Forums was lost, please wait while we try to reconnect.