diff --git a/README.md b/README.md index 7ecaeb4..2e3d601 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,41 @@
- +
# 🏔️ Training Program Exercises -This repository contains a selection of exercises intended for 2024 DevSoc Trainees. The exercises aim to develop basic web development skills, in HTML/CSS/JS and React. +This repository contains a selection of exercises intended for 2024 DevSoc Trainees. The exercises aim to develop basic web development skills, in HTML/CSS/JS and React. ## Getting Started -Before continuing please ensure that you have the following installed on your machine + +Before continuing please ensure that you have the following installed on your machine: + - Node - Git Clone this repository: -``` sh + +```sh git clone https://github.com/TAS-scorchedshadow/training-program-exercises.git ``` -Explore all the exercise on offer on our [Guide](https://tas-scorchedshadow.github.io/training-program-exercises/book) +Explore all the exercise on offer on our [Guide](https://tas-scorchedshadow.github.io/training-program-exercises/book). ## Contributing 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 + +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: -Please check that the book will render properly by running the following command in the root directory -``` sh +```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 +If the book has been updated correctly a new webpage will open in your browser. diff --git a/img/fullTransparent.svg b/img/fullTransparent.svg new file mode 100644 index 0000000..d67cda2 --- /dev/null +++ b/img/fullTransparent.svg @@ -0,0 +1,49 @@ + + +