I am a freak for templates. I template everything. I just don’t like to do anything more than once If I don’t have to. So yes, I made a template for my readme files. Now I’m publishing it here so you can use it too.
About:
ReadMe is a template for a simple XHTML readme file. It is used to produce attractive and user-friendly readme files that are viewable in any browser. The pre-styled markup and outline structure allow you to customize your readme by simply filling in the outline with your own information.
Requirements:
With a basic understanding of html (such as editing the text between the tags and leaving the html alone) and any text editor you can create your own readme file with ReadMe. With a more advanced understanding of html (such as creating your own list items and anchor links) you can extend the ReadMe outline to include even more headings.
Installation:
Open ReadMe in any text editor to make changes. To best employ your ReadME save it in the same directory as the file(s) to which it pertains.
Documentation:
To edit your ReadMe, open ReadMe in any text editor.
To change the content of a heading replace or add text between the … tags after any heading. If there are any html comment tags () before or after the heading, remove them.
To add your own custom headings first under the Menu heading find the menu item called YOUR CUSTOM HEADING and copy it. Paste it in the menu in whatever position you like. Remove the html comment tags (). Change the text YOUR CUSTOM HEADING to your desired heading title. then change name=”#custom” to name=”# followed by the title of your heading with no spaces or special characters (just stick with lower and uppercase letters, and numbers). Finally, close off that text with a double quote ( ” ). Now the menu will have a link to your new heading (once it has been created).
To create your new heading find the YOUR CUSTOM HEADING item at the bottom of the template. Remove the html comment tags (). Replace YOUR CUSTOM HEADING with the title of your heading. Replace href=”custom” with href=” followed by the same text you used following name=”# when you created the menu link. Finally, close off that text with a double quote ( ” ). Now you should have your new custom heading and a link in the menu that will navigate to it. See the instructions above to change the content of this new heading.
Known Issues:
ReadMe has been known to cause efficient workflows. ReadMe may cause users to become aware of useful information pertaining to files associated with your readme file.
