Project:Open Modding Licenses/ReadmeExample: Difference between revisions

Revision as of 00:11, May 10, 2016

Below is an example Readme file which can be used as a template.

HTML Version

<!DOCTYPE html>
<head>
<style>
include CSS styles here
</style>
<title>ModTitleHere</title>
</head>

<body>
<div id="right">
<p><a href="#1">Introduction</a></p>
<p><a href="#2">Terminology</a></p>
<p><a href="#3">Credits</a></p>
<p><a href="#4">Requirements</a></p>
<p><a href="#4a">Optionals</a></p>
<p><a href="#5">Links</a></p>
<p><a href="#6">Compatibility</a></p>
<p><a href="#7">Installation</a></p>
<p><a href="#7a">Overwrite Orders</a></p>
<p><a href="#8">Uninstallation / Updating</a></p>
<p><a href="#9">Mod Configuration Menu (MCM)</a><p>
<p><a href="#10">Performance</a></p>
</div>
</body>
</html>

Text Version

==============================================================================
Featured Mod Name Here
Current Version: ModVersion
License: Open Modding License (linkToLicense)
Created by: OriginalAuthorName

Currently Maintained by:
CurrentAuthorName,
CurrentAuthorName,
CurrentAuthorName 
==============================================================================

==============================================================================
Description
==============================================================================
Praesent gravida massa sem. Vivamus non dapibus purus. Phasellus bibendum suscipit vestibulum. Donec pulvinar interdum cursus. Vestibulum quis nulla ut odio viverra luctus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Pellentesque non neque eu lorem commodo congue vitae eget elit. Integer in posuere ante. Pellentesque rhoncus tellus et risus vulputate, non cursus quam interdum. Nullam at imperdiet ante. Cras maximus, arcu et blandit volutpat, est libero condimentum ante, at pellentesque elit dolor pharetra nibh.

Curabitur accumsan metus id est rhoncus suscipit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Quisque hendrerit risus aliquet quam malesuada, tempus tempus nunc consequat. Ut ut diam odio. Nunc metus nibh, molestie non lacinia aliquam, malesuada vitae ligula. Phasellus semper ac dolor et eleifend. Integer gravida eleifend eleifend. Duis et sagittis sapien. Nunc interdum placerat nisi, gravida lobortis ipsum hendrerit vel. Aliquam a elit ut ante pulvinar posuere. Quisque id urna nec libero rutrum commodo. Etiam velit leo, interdum vel tincidunt id, feugiat et erat. Suspendisse vulputate nunc vitae blandit ultrices. Maecenas a sapien neque. 

==============================================================================
Installation and Removal
==============================================================================
Installation
1. Quisque pharetra dui diam, ac lacinia nisl dapibus sit amet.
2. Suspendisse venenatis nunc ligula, volutpat vehicula tortor volutpat nec.
3. Nam at turpis in felis congue tristique.
4. Praesent non nisl sem. Pellentesque quis scelerisque ligula.
5. Nullam commodo at quam vitae venenatis.

Removal
1. Morbi id libero pulvinar ipsum tristique porta faucibus id justo. 
2. Aliquam a elit ut ante pulvinar posuere.
3. Etiam velit leo, interdum vel tincidunt id, feugiat et erat.

==============================================================================
Support
==============================================================================
Support can be found at the following link: LinkToSupportHere.

==============================================================================
Credits
==============================================================================
Original Author: OriginalAuthorName

Subsequent credits listed here in alphabetical order.