From 21e91810d6eb6ca99561f604e7af844fb92938e8 Mon Sep 17 00:00:00 2001 From: Dylan Date: Wed, 20 Dec 2023 22:04:45 +1100 Subject: [PATCH] Added instructions --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b92f17..7ecaeb4 100644 --- a/README.md +++ b/README.md @@ -20,5 +20,15 @@ Explore all the exercise on offer on our [Guide](https://tas-scorchedshadow.gith ## Contributing -When adding a new exercise please include a README in the repository. To be consistent with our guide please create a symbolic link to the README inside the relevant chapter in the book directory. You will also need to edit **summary.md** to recognise the new exercise. +When adding a new exercise +1. Inside **exercises**, create a new directory to contain the starter code +2. Inside **exercise-solutions**, create a new directory to contain the solutions, this should have the same name as the directory in exercises +3. Create a markdown file with the exercise instructions inside the **book/src** and add it to **book/src/SUMMARY.md**. + +Please check that the book will render properly by running the following command in the root directory +``` sh +$ mdbook build book --open +``` + +If the book has been updated correctly a new webpage will open in your browser. \ No newline at end of file