-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from jeremyle56/update-readme
Better light mode support for README.md
- Loading branch information
Showing
2 changed files
with
66 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,41 @@ | ||
<p align="center" style="padding: 0"> | ||
<img width='300' src="img/fullInvertTransparent.svg"> | ||
<picture> | ||
<source media="(prefers-color-scheme: light)" srcset="./img/fullTransparent.svg"> | ||
<img width='300' alt="DevSoc Logo" src="./img/fullInvertTransparent.svg"> | ||
</picture> | ||
</p> | ||
|
||
# 🏔️ 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. | ||
If the book has been updated correctly a new webpage will open in your browser. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.