Skip to content

Commit b5369ba

Browse files
committed
add commmands and directory explanations
1 parent 6d52acf commit b5369ba

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,41 @@
22

33

44

5+
## Repository template
6+
7+
Below are the folders and files in `book` directory:
8+
9+
- `_build` : built files using `jupyter-book build`
10+
11+
- `chapters ` : .ipynb files of the contents
12+
13+
- `pics` : image files used on the contents
14+
- `_config.yml` : configuration file for Jupyter Book
15+
- `_toc.yml` : table of contents file for Jupyter Book
16+
17+
18+
519
## How to contribute
620

721
1. fork [Pseudo-Lab/Tutorial-Book](https://github.com/Pseudo-Lab/Tutorial-Book)
22+
823
2. clone the forked repo to your local computer
24+
25+
```bash
26+
git clone
27+
```
28+
929
3. make necessary changes on the local repo
30+
1031
4. push the changes made on the local repo to the forked repo
32+
33+
```
34+
git add
35+
git commit
36+
git push
37+
```
38+
1139
5. create a pull request from the forked repo to [Pseudo-Lab/Tutorial-Book](https://github.com/Pseudo-Lab/Tutorial-Book)
40+
1241
6. Repeat step 3 and 5
1342

0 commit comments

Comments
 (0)