Jump to content

Mod Readme


Themisive

Recommended Posts

At present, I'm building a mod and will probably host it on the TES Nexus site. However, I have noticed that most people tend to use Notepad to maake the readme file for their mods. Unfortunately, there is no underline function in this programme, meaning that a lot of space is wasted in underscoring text.

 

To that end I have been thinking about writing the readme in Wordpad - it has Bold, Italic and Undeerscore features along with a numbering and bullet format as well as a rudimentory text formatting, I had thought of using Microsoft Office 2007, but though the format is backwards compatible with other forms of Microsoft Office, some people would not have it installed for various reasons.

 

Wordpad allows the text to be saved as any one of 4 different options; Rich Text (rtf), a text document (txt), a Text Document - MS-DOS format (txt) and finally a Unicode Text Document (txt).

 

Would this be acceptable?

Link to comment
Share on other sites

I have noticed that most people tend to use Notepad to maake the readme file for their mods.
Because it is the common denominator of which all other edits can be made. I typically use my Readme Generator to create the base framework. It then becomes my readme.txt file included in the mod. I then dress it up in BBCode for use in the description and then customize that even further for descriptions on other sites. The BBCode available in the description will work on the Nexus Forums for RELz threads and on the Official Bethesda forums for RELz threads there. You have to dumb it down a bit for PES descriptions since they only support just a small handful of BBCode (maybe just bold and underline). Wiki Code requires completely different coding but as long as you go based off your initial text-only design, it will look consistent no matter what format you use. And the more you do these conversions, the easier it gets. I usually make my plain text version and then the BBCode for the Nexus which allows the most codes. Then I use Notepad's Search/Replace feature to customize it for other sites that only support a subset of the code or transform it into Wiki Code.

 

Article: Formating and BBCode in Descriptions (@ Nexus)

 

Unfortunately, there is no underline function in this programme, meaning that a lot of space is wasted in underscoring text.
A necessary evil in plain text but most people do not mind as long as it is used consistently and not overdone.

 

Wordpad allows the text to be saved as any one of 4 different options; Rich Text (rtf), a text document (txt), a Text Document - MS-DOS format (txt) and finally a Unicode Text Document (txt).

 

Would this be acceptable?

Anything would be acceptable as long as the information can be obtained.

 

It would be "optimal" if a version is available in plain text or rich text. Some people (such as myself) will take the other formats (DOC, HTML) and convert them into TXT or RTF so they will import into OBMM nicely. Wouldn't work if it were in a PDF that did not allow copying of text, or in JPG or other non-editing formats.

 

LHammonds

Link to comment
Share on other sites

Personally I just do it as a text file if it's a small mod. MHE is a huge mod which requires a lot of explanation (a user's manual if you will) so I've written the readme as an .htm document. I guess it just depends on the mod and its author.
Link to comment
Share on other sites

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...