Project:Open Modding Licenses/ReadmeExample

From Step Mods | Change The Game

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

HTML Version[edit | edit source]

The following is an example HTML Readme document. You may use it as a reference for creating your own Readme file. The example is designed in HTML5 for high readability with a monotone gray color scheme.

Preview:

Warning-Logo.png

WARNING

This template is deprecated. Please revise markup to use Template:GallerySimple instead.

<!DOCTYPE html>
<head>
	<style>
<!--
==============================================================================
You can add your own custom CSS styles below. For those not accused with HTML
and CSS, a default layout style has been included for your convenience.
==============================================================================
-->
/* Document level adjustments */
html {}
body {padding: 0; margin: 0; font: 16px arial, sans-serif; color: #1f1f1f; line-height: 1.5em;}
@media (max-width: 900px) {html { font-size: 15px; }}
@media (max-width: 400px) {html { font-size: 13px; }}

/* Defines default tag formats */
h1 {font-size: 2.25em; letter-spacing: 0.025em; border-bottom: solid 1px #b3b3b3; margin: 0 0 0.5em 0; padding-left: 16px; line-height: 1.25em;}
h2 {font-size: 2em; letter-spacing: 0.025em;}
h3 {font-size: 1.5em; letter-spacing: 0.025em;}
h4 {font-size: 1.25em; letter-spacing: 0.025em;}
h5 {font-size: 1em; letter-spacing: 0.025em;}
p {text-indent: 30px;}
blockquote {background-color: #fcfcfc; border-left: 5px solid #ccc; border-radius: 15px; color: #686868; font-style: italic; margin: 25px 100px 5px 50px; padding: 5px 5px 5px 15px;}

/* Layout structure - sections scale with window size */
section {float: left; width: 77%; clear: both; margin: 1em 0 2em 0; padding: 0.75em;}
aside {position: fixed; top: 0; right: 0; height: 97%; width: 20%; padding: 0.75em; border: solid 1px #ccc; font-size: 0.9rem; color: #000; background-color: #eae9e9;}
footer {clear: both; position: fixed; bottom: 0; height: 3%; width: 100%; padding: 0; border-top: solid 1px #a5a5a5; font-size: 0.8rem; text-align: center; background-color: #b3b3b3;}
@media (max-width: 900px) {.content { width: 60%; }.sidebar { width: 40%; }}
@media (max-width: 400px) {.content, .sidebar { float: none; width: auto; }}

/* Classes for various things */
/* header style */
h1.title {font-size: 3.2em; letter-spacing: 0.02em; border-bottom: solid 1px #b3b3b3; margin: 0 0 0.2em 0; padding: 0; line-height: 1em;}

/* For centering things */
.center {display: block; margin: 0 auto; width: 100%; text-align: center;}

/* Vertically center an element on the page */
.vcenter {position: absolute; top: 50%; transform: translateY(-50%);}

/* Meduim and Small font sizes */
.fontmedium {font-size: 0.85rem;}
.fontsmall {font-size: 0.7rem;}

/* No indent with allow things with indents to not be indented...like paragraphs and lists */
.noindent {text-indent: 0px;}

/* Header for the navbar */
div.navHeader {font-weight: bold; padding: 4px 0px 0px 12px; font-size: 1.5rem; clear: both; border-bottom: solid 1px #ccc; line-height: 1.25em;}

/* Navbar class that makes the links pretty */
nav ul {list-style-type: none; margin: 0; padding: 0; width: 100%; line-height: 1.3em;}
nav li a {display: block; color: #000; padding: 6px 0 6px 25px; text-decoration: none;}
nav li a:hover {background-color: #fff; font-weight: bold; color: #3c3c3c;}
	</style>
	<title>ModTitleHere</title>
</head>
<body>
<!--
==============================================================================
Sidebar content area.
==============================================================================
-->
<aside>
<nav>
<div class="navHeader">Navigation</div>
<ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#requires">Requirements</a></li>
<li><a href="#compat">Compatibility</a></li>
<li><a href="#links">Links</a></li>
<li><a href="#install">Installation</a></li>
<li><a href="#uninstall">Updating / Uninstallation</a></li>
<li><a href="#mcm">Mod Configuration Menu (MCM)</a></li>
<li><a href="#license">Licensing Information</a></li>
<li onclick="myFunction()"><a href="#credits">Credits</a></li>
</ul>
</nav>
</aside>
<!--
==============================================================================
Main content area.
==============================================================================
-->
<section>
	<h1 class="title center">Mod Title Here</h1>
	<h4 class="center">Created by: Original Author</h4>
	<h5 class="center">Currently maintained by: Author</h5>
	<span class="center">Current version: X.x.x</span>
</section>

<section>
	<h1 id="intro">Introduction</h1>
	<p>Something Something Something Dark Side...</p>
	<p class="fontmedium">This is medium sized text.</p>
	<p class="fontsmall">This is small sized text.</p>
</section>

<section>
	<h1 id="requires">Requirements</h1>
	<p>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.</p>

	<p>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.</p>
	<ul>
		<li>Item 1</li>
		<li>Item 2</li>
		<li>Item 3</li>
		<li>Item 4</li>
	</ul>
</section>

<section>
	<h1 id="compat">Compatibility</h1>
	<p>The following is a list of compatible mods:</p>
	<ul>
		<li>Item 1</li>
		<li>Item 2</li>
		<li>Item 3</li>
		<li>Item 4</li>
	</ul>
</section>

<section>
	<h1 id="links">Links</h1>
	<p>The following is a list of links which will lead you to where you need to go...</p>
</section>

<section>
	<h1 id="install">Installation</h1>
	<p>Follow the instructions to install the mod:</p>
	<ul>
		<li>Item 1</li>
		<li>Item 2</li>
		<li>Item 3</li>
		<li>Item 4</li>
	</ul>
</section>

<section>
	<h1 id="uninstall">Updating & Uninstallation</h1>
	<h2>Updating</h2>
	<p>To update the mod, do the following:</p>
	<ul>
		<li>Item 1</li>
		<li>Item 2</li>
		<li>Item 3</li>
		<li>Item 4</li>
	</ul>
	<h2>Uninstallation</h2>
	<p>To uninstall the mod, do the following:</p>
	<ul>
		<li>Item 1</li>
		<li>Item 2</li>
		<li>Item 3</li>
		<li>Item 4</li>
	</ul>
</section>

<section>
	<h1 id="mcm">Mod Configuration Menu (MCM)</h1>
	<p>These menus are out of the world!</p>
</section>

<section>
	<h1 id="license">Licensing Information</h1>
	<p>Licensed under OML.</p>
</section>

<section>
	<h1 id="credits">Credits</h1>
	<p>Giving credit where credit is due:</p>
Original Author: nameHere
</section>
<!--
==============================================================================
Footer content area.
==============================================================================
-->
<footer>
<span class="vcenter">Open Modding Group | Licensed under OML</span>
</footer>
</body>
</html>

Text Version[edit | edit source]

==============================================================================
Featured Mod Name Here
Created by: OriginalAuthorName
Current Version: ModVersion

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.

==============================================================================
Licensing Information
==============================================================================
Open Modding License (linkToLicense)

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

Subsequent credits listed here in alphabetical order.
Retrieved from "https://stepmodifications.org/wiki/index.php?title=Project:Open_Modding_Licenses/ReadmeExample&oldid=146986"