From 738d54b1c43def81b5faf08e897eae1fb306c23a Mon Sep 17 00:00:00 2001 From: Dan Goldsmith Date: Sun, 5 Jul 2020 11:19:50 +0100 Subject: [PATCH] Move Docs to main folder --- README.md | 20 ++++++++++ TODO.md | 6 +++ docs/{docs => }/FAQ.md | 0 docs/docs/gettingstarted.md | 14 ------- docs/{docs => }/index.md | 0 docs/mkdocs.yml | 1 - docs/tutorial.md | 80 +++++++++++++++++++++++++++++++++++++ docs/{docs => }/why.md | 0 mkdocs.yml | 7 ++++ 9 files changed, 113 insertions(+), 15 deletions(-) create mode 100644 TODO.md rename docs/{docs => }/FAQ.md (100%) delete mode 100644 docs/docs/gettingstarted.md rename docs/{docs => }/index.md (100%) delete mode 100644 docs/mkdocs.yml create mode 100644 docs/tutorial.md rename docs/{docs => }/why.md (100%) create mode 100644 mkdocs.yml diff --git a/README.md b/README.md index 63cc760..b5af063 100644 --- 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 + +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 new file mode 100644 index 0000000..d83cdbb --- /dev/null +++ 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 b/docs/FAQ.md similarity index 100% rename from docs/docs/FAQ.md rename to docs/FAQ.md diff --git a/docs/docs/gettingstarted.md b/docs/docs/gettingstarted.md deleted file mode 100644 index e7340bb..0000000 --- a/docs/docs/gettingstarted.md +++ /dev/null @@ -1,14 +0,0 @@ -# Getting Started - -## Requirements - -## Installing - - -## Building our Template Document - -## Modifying our Template - - - - diff --git a/docs/docs/index.md b/docs/index.md similarity index 100% rename from docs/docs/index.md rename to docs/index.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index 296c0b9..0000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1 +0,0 @@ -site_name: Markdown Mark diff --git a/docs/tutorial.md b/docs/tutorial.md new file mode 100644 index 0000000..4b50731 --- /dev/null +++ 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 // +``` + + +
+### 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 +``` +
+ +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 b/docs/why.md similarity index 100% rename from docs/docs/why.md rename to docs/why.md diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..6983cb2 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,7 @@ +site_name: Markdown Mark + +nav: + - Home: index.md + - Tutorial: tutorial.md + - Why: why.md + - FAQ: FAQ.md