From 9533b5060b5bc30a8ead46f651f53332a0082d08 Mon Sep 17 00:00:00 2001 From: Dan Goldsmith Date: Tue, 24 Apr 2018 16:54:33 +0100 Subject: [PATCH] README update --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index ec87022..a6678f4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # markdown_dissertation Markdown Dissertation Template + +## Credits + +# Usage + +NOTE: There must be a better way of doing this too. Possibly submodule-init? + + - Clone the Repository + - Copy the Supporting and Template Files into your Repo + - Copy the Frontpage.md and Build.sh File into your Repo + + +## Frontpage.md + +Contains all the setup stuff. Hopefully you just need to edit the top part of the YAML file. Otherwise its all self explanatory (I think) + + - Supporting directory contains a markdown Decalration of Originlaity (Cheers Nate) You will alos need to modify this + +## Build.sh + + - Modify the script to contain your files in order. Should be easy enough. + +# TODO List + +Appendicies? + + - No Idea