From e96f0c0e047530e98efd71490d18a3acb0c8fabb Mon Sep 17 00:00:00 2001 From: Maschell Date: Tue, 24 Jul 2018 16:43:47 +0200 Subject: [PATCH] Updated the README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f56859..3f1c7c1 100644 --- a/README.md +++ b/README.md @@ -1 +1,8 @@ -Open me at: [https://maschell.github.io/WiiUPluginSystem](https://maschell.github.io/WiiUPluginSystem) \ No newline at end of file +Open me at: [https://maschell.github.io/WiiUPluginSystem](https://maschell.github.io/WiiUPluginSystem) + +For hosting a local version, you need to have [Jekyll](https://jekyllrb.com/) installed. +A installation guide for windows can be found [here](https://idratherbewriting.com/documentation-theme-jekyll/mydoc_install_jekyll_on_windows.html). + +To start local version: Open the `jekyll.sh` bash script and the website will be live at `http://localhost:4000/WiiUPluginSystem/`. + +Based on [Jekyll](https://jekyllrb.com/) usin the [Jekyll documentation theme](https://idratherbewriting.com/documentation-theme-jekyll/).