Move Docs to main folder

csx239 · Jul 5, 2020 · 738d54b1c43def81b5faf08e897eae1fb306c23a · 738d54b
1 parent 42f4453
commit 738d54b1c43def81b5faf08e897eae1fb306c23a
Show file tree

Hide file tree

Showing 9 changed files with 113 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -86,3 +86,23 @@ Paths / Organisation for the Templates  do it
 
 The second is better for orgnaisation,  but a makes the command line clunky.
 We could map in the main function though...
+
+
+## Documentation
+
+Can be found <here>
+
+Generated with MKDocs
+
+To regenerate the docs 
+
+~~~
+#Install
+$pip install mkdocs
+
+#Build (in the docs directory)
+docs$ mkdocs build
+
+#Preview 
+docs$ mkdocs serve
+~~~
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,6 @@
+#TODO List
+
+ - Windows specific version of the Guide
+ - Images in the Guide
+ - Update Links to Course code Location
+ - Once we have a proper projet name (I think reMarkAble) let keep it.
diff --git a/docs/docs/FAQ.md → docs/FAQ.md b/docs/docs/FAQ.md → docs/FAQ.md
diff --git a/docs/docs/gettingstarted.md b/docs/docs/gettingstarted.md
diff --git a/docs/docs/index.md → docs/index.md b/docs/docs/index.md → docs/index.md
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -0,0 +1,80 @@
+# Tutorial
+
+A Quick Start Guide for using the tool.
+This assumes a generic Linux / Mac / Windows system.
+
+I will put together a specific version for a
+University Windows image, when I work out the Gotchas.
+
+## Requirements
+
+All the requirements should be in the standard uni image.
+
+  - Web Browser
+  - Text Editor
+  - Python (3.x preferred)
+
+All the code uses native python packages, so there should be no need
+to install any other software.
+
+## Installation
+
+Get a copy of the source code from the [Github
+Repo](https://github.coventry.ac.uk/aa9863/MarkdownMark) It doesn't
+matter if you clone the repository or get the zip file.
+
+Once you have the code navigate to its location using the command line.
+
+```
+cd <path>/<to>/<source>
+```
+
+
+<div class="noteblock">
+### OPTIONAL: Using a virtaul envionment
+
+Virtual environments (venv) give us a way of sandboxing python software we
+install.  It means that they are not installed in the global path.
+Personally, as a developer, I prefer this as it means I dont get caught out by
+dependencies or clutter up my Python namespace with cruft.
+
+We can create a venv using
+
+```bash
+python -m venv env
+```
+
+Each time we want to use the code we need to access enter the virtual environment.
+We can do this in Linux / mac with
+
+```bash
+$source env/bin/activate
+```
+
+or Windows
+```
+C:\> env\Scripts\activate.bat
+```
+</div>
+
+We can now install the program using the setup script.
+
+
+```bash
+$ python setup.py install
+```
+
+
+## Building our First Document
+
+```
+cd examples
+$ runDMC CourseworkBrief.md -t coursework/CourseworkBrief.jinja2
+````
+
+## Modifying our Document
+
+## Creating Marking Feedback
+
+
+
diff --git a/docs/docs/why.md → docs/why.md b/docs/docs/why.md → docs/why.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,7 @@
+site_name: Markdown Mark
+
+nav:
+  - Home: index.md
+  - Tutorial: tutorial.md
+  - Why: why.md
+  - FAQ: FAQ.md