Skip to content

Commit 62c1c20

Browse files
added readme file
1 parent 2fd1c1e commit 62c1c20

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Course Code & Materials
2+
3+
This repository contains the course source code and other extra materials like slides.
4+
5+
## How to use
6+
7+
The code snapshots are organized in multiple **branches** where every branch **represents a course section**.
8+
9+
For example, the branch [01-getting-started](https://github.com/academind/react-complete-guide-code/tree/01-getting-started) holds all code snapshots and extra materials for section 1 of the course ("Getting Started").
10+
11+
You can switch branches via the branch dropdown above the directory explorer.
12+
13+
![Click on the branch dropdown and then select the appropriate branch for the course section you're looking for](./selecting-a-branch.jpg)
14+
15+
In most branches, you'll find multiple folders which organize the section-specific content further:
16+
17+
- Often, you'll find a `/code` subfolder which contains any relevent code snapshots for the given course section
18+
- You also often find `/slides` folders which - guess what - contain the slides for the module
19+
- `/extra-files` typically contains extra files like `.css` files that might be attached to individual lectures in that course module
20+
21+
The folder names should generally be self-explanatory but also feel free to simply click around and see which materials are available.
22+
23+
## Using code snapshots
24+
25+
Code snapshots (which you find in `/code`) are there for you to compare your code to mine and find + fix errors you might have in your code.
26+
27+
You can either view my code directly here on Github (you can open + view code files without issues here) or you download the snapshots.
28+
29+
### Downloading code snapshots
30+
31+
You can download all the content of a branch via the "Code" button here on Github. You can then either [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the repository or simply download the selected branch content as a ZIP file.
32+
33+
**Important:** You always download the **entire branch content!**
34+
35+
You can then dive into the interesting folders (e.g. the individual code snapshots) locally on your hard drive.

selecting-a-branch.jpg

98.3 KB
Loading

0 commit comments

Comments
 (0)