From 13d63c849fd022b8aa525021223fd4aba4df2a8d Mon Sep 17 00:00:00 2001 From: Dan Goldsmith Date: Wed, 8 Jul 2020 08:03:32 +0100 Subject: [PATCH] Readme update to point to documentation --- .gitignore | 3 ++- README.md | 2 +- docs/index.md | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 7c9175b..bacd1f0 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ *.egg-info* .eggs env/* -__pycache__ \ No newline at end of file +__pycache__ +site \ No newline at end of file diff --git a/README.md b/README.md index 55ae4ac..51594c8 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Use markdown to generate various forms I have to fill in. ## Documentation -Documentation can be found [HERE](docs/) +There is also some [Documentation](https://github.coventry.ac.uk/pages/aa9863/reMarkAble/) Current State of the documents is diff --git a/docs/index.md b/docs/index.md index c9c5467..092519c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,6 +33,7 @@ to install any other software. - [Installation](install.md) - [Tutorial](tutorial.md) + # Improvements and Contributing ## Bugs or Undocumented Features?