Skip to content

Commit 145d6d6

Browse files
authored
Merge pull request #19 from SDSTony/master
add contents on README file
2 parents 5c8b0fa + b5369ba commit 145d6d6

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# Deep Learning Tutorials using PyTorch (PseudoLab)
22

3+
4+
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+
19+
## How to contribute
20+
21+
1. fork [Pseudo-Lab/Tutorial-Book](https://github.com/Pseudo-Lab/Tutorial-Book)
22+
23+
2. clone the forked repo to your local computer
24+
25+
```bash
26+
git clone
27+
```
28+
29+
3. make necessary changes on the local repo
30+
31+
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+
39+
5. create a pull request from the forked repo to [Pseudo-Lab/Tutorial-Book](https://github.com/Pseudo-Lab/Tutorial-Book)
40+
41+
6. Repeat step 3 and 5
42+

0 commit comments

Comments
 (0)