Updated docs and mkdoc theme.

BuvinJT · Jan 13, 2019 · 723770e · 723770e
1 parent 3e8c48c
commit 723770e
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 11 deletions.
diff --git a/docs/Contribute.md b/docs/Contribute.md
@@ -0,0 +1,21 @@
+# Contact / Contribute
+![distbuilder logo](https://raw.githubusercontent.com/BuvinJT/distbuilder/master/docs/distbuilder128.png)
+
+## Join GitHub 
+
+If you wish to report bugs, make request features, or contribute to this 
+project, please [join GitHub](https://github.com/join). 
+
+## Post Issue 
+
+Once you have a GitHub account, you can [post an issue](https://github.com/BuvinJT/distbuilder/issues)
+for this project.  
+
+## Contribute Code
+
+If you wish to contribute code, create your own fork from 
+[distbuilder](https://github.com/BuvinJT/distbuilder).
+After that, git clone your fork, and push the commits.
+Finally, issue a [pull request](https://github.com/BuvinJT/distbuilder/pulls).
+Upon review, your contribution maybe merged into the official 
+project.
diff --git a/docs/Reference.md b/docs/Reference.md
@@ -464,7 +464,7 @@ The following two options are available for a QtIFW installer:
    the installer, try setting `qtIfwConfig.isDebugMode` 
    to `True` for verbose output.
 
-## Archives & Distribution
+## Archives and Distribution
 
 Once you have a fully built distribution package, the 
 following functions provide an easy means for further 

diff --git a/docs/ToDo.md b/docs/ToDo.md
@@ -1,7 +1,7 @@
 # To-Do List 
 ![distbuilder logo](https://raw.githubusercontent.com/BuvinJT/distbuilder/master/docs/distbuilder128.png)
-
-### High Priority
+ 
+## High Priority
 
 * Test on platforms other than Windows! 
 	(should work in theory, but confirmation required)
@@ -11,7 +11,7 @@
 * Continue to expand upon the documentation, especially with
 regard to the various configuration options. 
 
-### Moderate Priority
+## Moderate Priority
 
 * Further develop external library bundling (for Opy), making such 
 more automated and less work for the user (e.g. finding external library 
@@ -27,7 +27,7 @@ divisions.
 
 * Continue to improve and stablize the Opy library and its beta features.
 
-### Low Priority
+## Low Priority
 
 * Add the options to build projects outside of the project directory.  
 (Both the source and the temp build directories.)  
@@ -42,7 +42,7 @@ XML config classes.
 
 * Add tarball alternative to zip packaging.
 
-### Wish List		
+## Wish List		
 
 * Add a Py2Exe wrapper as alternative to PyInstaller.
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Overview 
+# Distribution Builder Python Library
 ![distbuilder logo](https://raw.githubusercontent.com/BuvinJT/distbuilder/master/docs/distbuilder128.png)
 
 "Distribution Builder" (distbuilder) is an open source (GPLv3) Python library.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,8 @@
 site_name: Distribution Builder
 pages:
-    - Overview: index.md
-    - Quick Start: QuickStart.md
-    - Reference: Reference.md
-    - To-Do: ToDo.md
+    - Home: index.md
+    - Quick Start Guide: QuickStart.md
+    - Reference Manual: Reference.md
+    - To-Do List: ToDo.md
+    - Contact / Contribute: Contribute.md
+theme: windmill