New front page

ShawnDriscoll · Oct 1, 2017 · 38307d0 · 38307d0
1 parent 8119440
commit 38307d0
Show file tree

Hide file tree

Showing 27 changed files with 355 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,4 @@
 <img src="docs/source/diceroll.png"><br><br>
-
-
-<h1>diceroll 2.2</h1><br>
+diceroll 2.2<br>
 ============<br>
 Read the <b>diceroll manual</b> at <a href="http://diceroll.readthedocs.io/">Read the Docs</a>.<br><br>
diff --git a/docs/build/.doctrees/diceroll.doctree b/docs/build/.doctrees/diceroll.doctree
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/index.doctree b/docs/build/.doctrees/index.doctree
diff --git a/docs/build/.doctrees/project.doctree b/docs/build/.doctrees/project.doctree
diff --git a/docs/build/.doctrees/tutorial.doctree b/docs/build/.doctrees/tutorial.doctree
diff --git a/docs/build/.doctrees/worm.doctree b/docs/build/.doctrees/worm.doctree
diff --git a/docs/build/_sources/diceroll.txt b/docs/build/_sources/diceroll.txt
@@ -1,5 +1,5 @@
-diceroll module
-===============
+**diceroll Module**
+===================
 
 .. automodule:: diceroll
-   :members:
+   :members:
diff --git a/docs/build/_sources/index.txt b/docs/build/_sources/index.txt
@@ -3,12 +3,26 @@
 diceroll 2.2 Manual
 ===================
 
-A dice rolling module.
-
-Requirements:
-
-* Microsoft Windows
-* CPython 2.5
+**A dice rolling module**
+
+Requirements
+------------
+
+* **Microsoft Windows**
+       | This code has been tested on versions: XP, 7, 8, and 10. It has
+       | not been tested on MacOS or Linux.
+* **Python 2.5**
+       | This module was written using the C implementation of Python
+       | version 2.5.4. Also known as CPython. With some doing, this
+       | module could of course be re-written for Jython, PyPy, or
+       | IronPython.
+       |
+       | Eclypse/PyDev, PyCharm, NetBeans, and IDLE all work fine for
+       | running this module in.
+
+.. Warning::
+   diceroll will not work with Python 2.6+.
+
 
 
 Contents
@@ -17,11 +31,11 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   tutorial
    project
+   tutorial
    diceroll
 
-Indices and tables
+Indices and Tables
 ------------------
 
 * :ref:`genindex`

diff --git a/docs/build/_sources/project.txt b/docs/build/_sources/project.txt
@@ -1,5 +1,5 @@
-Project Summary
-===============
+**Project Summary**
+===================
 
 Goals Achieved
 --------------
@@ -11,6 +11,8 @@ Goal 2 = This is the title of my second goal.
 
 This is the description of what I managed to complete on this goal.
 
+.. versionadded:: 2.2
+
 Lessons Learned
 ---------------
 This is a paragraph describing what I learned from this project.
diff --git a/docs/build/_sources/tutorial.txt b/docs/build/_sources/tutorial.txt
@@ -1,5 +1,5 @@
-diceroll Tutorial
-===================
+**diceroll Tutorial**
+=================
 
 This is a short description about how to use diceroll: ::
 

diff --git a/docs/build/_sources/worm.txt b/docs/build/_sources/worm.txt
@@ -0,0 +1,38 @@
+
+Sirene Geest Worm
+-----------------
+
+| Though referred to as a worm, this tortoise-sized armoured creature is characterised
+| by a special bony or cartilaginous shell developed from their maw which acts as its
+| shield. Residing in the Sirene's maw is a collection of worms whose purpose is to
+| bring scavenged food to the creature. Since it has no legs, the worms also push and
+| pull on the shell to move it around. Sirenes are telepathic and will use suggestion
+|    to "lure" nearby Travellers into killing themselves. Worms are then released from
+| the maw to slowly "dissect" the victim and carry food back to the maw. Sirenes are
+| typically found behind objects and never out in the open. Air ducts are a favourite
+| spot.
+
+
++-----------+-------------------------------------------------------------+-------+
+| Animal    | Hits                                                        | Speed |
+|           |                                                             |       |
++-----------+-------------------------------------------------------------+-------+
+| Sirene    | 10                                                          | 1 m   |
+|           |                                                             |       |
++-----------+-------------------------------------------------------------+-------+
+| Skills    | Deception 2, Recon 1, Stealth 4, Telepathy 3                        |
+|           |                                                                     |
+|           |                                                                     |
++-----------+---------------------------------------------------------------------+
+| Attacks   | None                                                                |
+|           |                                                                     |
+|           |                                                                     |
++-----------+---------------------------------------------------------------------+
+| Traits    | Armour (+2), Camouflaged, Psionic (3), Slow Metabolism (-2)         |
+|           |                                                                     |
++-----------+---------------------------------------------------------------------+
+| Behaviour | Carnivore, Reducer, Siren                                           |
+|           |                                                                     |
++-----------+---------------------------------------------------------------------+
+
+
diff --git a/docs/build/diceroll.html b/docs/build/diceroll.html
@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>diceroll module &mdash; diceroll v2.2.1b documentation</title>
+    <title>diceroll Module &mdash; diceroll 2.2 Manual</title>
     <link rel="stylesheet" href="_static/default.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript">
@@ -19,8 +19,8 @@
     <link rel="contents" title="Global table of contents" href="contents.html" />
     <link rel="index" title="Global index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="top" title="diceroll v2.2.1b documentation" href="index.html" />
-    <link rel="prev" title="Project Summary" href="project.html" />
+    <link rel="top" title="diceroll 2.2 Manual" href="index.html" />
+    <link rel="prev" title="diceroll Tutorial" href="tutorial.html" />
   </head>
   <body>
     <div class="related">
@@ -33,9 +33,9 @@ <h3>Navigation</h3>
           <a href="modindex.html" title="Global Module Index"
              accesskey="M">modules</a> |</li>
         <li class="right" >
-          <a href="project.html" title="Project Summary"
+          <a href="tutorial.html" title="diceroll Tutorial"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="index.html">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="document">
@@ -45,7 +45,7 @@ <h3>Navigation</h3>
 
 
   <div class="section" id="module-diceroll">
-<h1>diceroll module<a class="headerlink" href="#module-diceroll" title="Permalink to this headline">¶</a></h1>
+<h1><strong>diceroll Module</strong><a class="headerlink" href="#module-diceroll" title="Permalink to this headline">¶</a></h1>
 <dl class="docutils">
 <dt>Usage:</dt>
 <dd><p class="first">from diceroll import roll</p>
@@ -92,7 +92,7 @@ <h1>diceroll module<a class="headerlink" href="#module-diceroll" title="Permalin
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
             <h4>Previous topic</h4>
-            <p class="topless"><a href="project.html" title="previous chapter">Project Summary</a></p>
+            <p class="topless"><a href="tutorial.html" title="previous chapter"><strong>diceroll Tutorial</strong></a></p>
             <h3>This Page</h3>
             <ul class="this-page-menu">
               <li><a href="_sources/diceroll.txt">Show Source</a></li>
@@ -117,9 +117,9 @@ <h3>Navigation</h3>
           <a href="modindex.html" title="Global Module Index"
              accesskey="M">modules</a> |</li>
         <li class="right" >
-          <a href="project.html" title="Project Summary"
+          <a href="tutorial.html" title="diceroll Tutorial"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="index.html">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/build/genindex.html b/docs/build/genindex.html
@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Index &mdash; diceroll v2.2.1b documentation</title>
+    <title>Index &mdash; diceroll 2.2 Manual</title>
     <link rel="stylesheet" href="_static/default.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript">
@@ -19,7 +19,7 @@
     <link rel="contents" title="Global table of contents" href="contents.html" />
     <link rel="index" title="Global index" href="" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="top" title="diceroll v2.2.1b documentation" href="index.html" />
+    <link rel="top" title="diceroll 2.2 Manual" href="index.html" />
   </head>
   <body>
     <div class="related">
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="modindex.html" title="Global Module Index"
              accesskey="M">modules</a> |</li>
-        <li><a href="index.html">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="index.html">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="document">
@@ -91,7 +91,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="modindex.html" title="Global Module Index"
              accesskey="M">modules</a> |</li>
-        <li><a href="index.html">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="index.html">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/build/index.html b/docs/build/index.html
@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>diceroll 2.2 Manual &mdash; diceroll v2.2.1b documentation</title>
+    <title>diceroll 2.2 Manual &mdash; diceroll 2.2 Manual</title>
     <link rel="stylesheet" href="_static/default.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript">
@@ -19,8 +19,8 @@
     <link rel="contents" title="Global table of contents" href="contents.html" />
     <link rel="index" title="Global index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="top" title="diceroll v2.2.1b documentation" href="" />
-    <link rel="next" title="diceroll Tutorial" href="tutorial.html" />
+    <link rel="top" title="diceroll 2.2 Manual" href="" />
+    <link rel="next" title="Project Summary" href="project.html" />
   </head>
   <body>
     <div class="related">
@@ -33,9 +33,9 @@ <h3>Navigation</h3>
           <a href="modindex.html" title="Global Module Index"
              accesskey="M">modules</a> |</li>
         <li class="right" >
-          <a href="tutorial.html" title="diceroll Tutorial"
+          <a href="project.html" title="Project Summary"
              accesskey="N">next</a> |</li>
-        <li><a href="">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="document">
@@ -47,30 +47,57 @@ <h3>Navigation</h3>
   <img alt="_images/diceroll_cover.png" src="_images/diceroll_cover.png" />
 <div class="section" id="diceroll-2-2-manual">
 <h1>diceroll 2.2 Manual<a class="headerlink" href="#diceroll-2-2-manual" title="Permalink to this headline">¶</a></h1>
-<p>A dice rolling module.</p>
-<p>Requirements:</p>
-<ul class="simple">
-<li>Microsoft Windows</li>
-<li>CPython 2.5</li>
+<p><strong>A dice rolling module</strong></p>
+<div class="section" id="requirements">
+<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><dl class="first docutils">
+<dt><strong>Microsoft Windows</strong></dt>
+<dd><div class="first last line-block">
+<div class="line">This code has been tested on versions: XP, 7, 8, and 10. It has</div>
+<div class="line">not been tested on MacOS or Linux.</div>
+</div>
+</dd>
+</dl>
+</li>
+<li><dl class="first docutils">
+<dt><strong>Python 2.5</strong></dt>
+<dd><div class="first last line-block">
+<div class="line">This module was written using the C implementation of Python</div>
+<div class="line">version 2.5.4. Also known as CPython. With some doing, this</div>
+<div class="line">module could of course be re-written for Jython, PyPy, or</div>
+<div class="line">IronPython.</div>
+<div class="line"><br /></div>
+<div class="line">Eclypse/PyDev, PyCharm, NetBeans, and IDLE all work fine for</div>
+<div class="line">running this module in.</div>
+</div>
+</dd>
+</dl>
+</li>
 </ul>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">diceroll will not work with Python 2.6+.</p>
+</div>
+</div>
 <div class="section" id="contents">
 <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
 <ul>
-<li><a class="reference external" href="tutorial.html">diceroll Tutorial</a></li>
-</ul>
-<ul>
-<li><a class="reference external" href="project.html">Project Summary</a><ul>
+<li><a class="reference external" href="project.html"><strong>Project Summary</strong></a><ul>
 <li><a class="reference external" href="project.html#goals-achieved">Goals Achieved</a></li>
 <li><a class="reference external" href="project.html#lessons-learned">Lessons Learned</a></li>
 </ul>
 </li>
 </ul>
 <ul>
-<li><a class="reference external" href="diceroll.html">diceroll module</a></li>
+<li><a class="reference external" href="tutorial.html"><strong>diceroll Tutorial</strong></a></li>
+</ul>
+<ul>
+<li><a class="reference external" href="diceroll.html"><strong>diceroll Module</strong></a></li>
 </ul>
 </div>
 <div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
+<h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
 <li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
@@ -88,16 +115,17 @@ <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
             <h3>Table Of Contents</h3>
             <ul>
 <li><a class="reference external" href="">diceroll 2.2 Manual</a><ul>
+<li><a class="reference external" href="#requirements">Requirements</a></li>
 <li><a class="reference external" href="#contents">Contents</a><ul>
 </ul>
 </li>
-<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
+<li><a class="reference external" href="#indices-and-tables">Indices and Tables</a></li>
 </ul>
 </li>
 </ul>
 
             <h4>Next topic</h4>
-            <p class="topless"><a href="tutorial.html" title="next chapter">diceroll Tutorial</a></p>
+            <p class="topless"><a href="project.html" title="next chapter"><strong>Project Summary</strong></a></p>
             <h3>This Page</h3>
             <ul class="this-page-menu">
               <li><a href="_sources/index.txt">Show Source</a></li>
@@ -122,9 +150,9 @@ <h3>Navigation</h3>
           <a href="modindex.html" title="Global Module Index"
              accesskey="M">modules</a> |</li>
         <li class="right" >
-          <a href="tutorial.html" title="diceroll Tutorial"
+          <a href="project.html" title="Project Summary"
              accesskey="N">next</a> |</li>
-        <li><a href="">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/build/modindex.html b/docs/build/modindex.html
@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Global Module Index &mdash; diceroll v2.2.1b documentation</title>
+    <title>Global Module Index &mdash; diceroll 2.2 Manual</title>
     <link rel="stylesheet" href="_static/default.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript">
@@ -19,8 +19,8 @@
     <link rel="contents" title="Global table of contents" href="contents.html" />
     <link rel="index" title="Global index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="top" title="diceroll v2.2.1b documentation" href="index.html" />
-<generator object at 0x0359F828>
+    <link rel="top" title="diceroll 2.2 Manual" href="index.html" />
+<generator object at 0x03569990>
 
     <script type="text/javascript">
       DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX = true;
@@ -38,7 +38,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="" title="Global Module Index"
              accesskey="M">modules</a> |</li>
-        <li><a href="index.html">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="index.html">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="document">
@@ -86,7 +86,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="" title="Global Module Index"
              accesskey="M">modules</a> |</li>
-        <li><a href="index.html">diceroll v2.2.1b documentation</a> &raquo;</li>
+        <li><a href="index.html">diceroll 2.2 Manual</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">