From 3d5a498d94698b50d98437ae4f8fb5f68acde9c3 Mon Sep 17 00:00:00 2001 From: Eljakim Herrewijnen Date: Sat, 19 Nov 2022 20:30:58 +0100 Subject: [PATCH] Added usage for readthedocs in readme --- Readme.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index eff26b6..9a100cb 100644 --- a/Readme.md +++ b/Readme.md @@ -2,4 +2,19 @@ This repository contains the code and projects that Ithamar is doing and has done for his Associate Degree. ## Structure -the documentation/ folder contains the **readthedocs** source that will be updated by Ithamar according to the assignments he needs to make. The **assignments** folder contains the assignments made by Ithamar. \ No newline at end of file +the documentation/ folder contains the **readthedocs** source that will be updated by Ithamar according to the assignments he needs to make. The **assignments** folder contains the assignments made by Ithamar. + +### Usage: +To build the navigation, go to *documentation/readthedocs* and execute: + +``` +make html +``` + +Next, navigate to build/html and run a webserver: + +``` +python3 -m http.server +``` +This will start a webserver on port **localhost:8000**. Navigate to this URL in your browser. +