Skip to content

Commit c82b00f

Browse files
committed
documented step-by-step to add notebooks
1 parent 3dea473 commit c82b00f

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ This repository is a collection of useful [Python notebooks](https://jupyter.org
77
# Notebook Name
88
Description
99

10-
---
11-
## NB Section
12-
[Optional] Description
13-
14-
`code`
15-
...
10+
... (code, markdown, etc.)
1611
```
1712

1813
## Adding Notebooks
19-
Simply copy the `.ipynb` files to `notebooks/library`. It's highly recommended to run the `cataloguer.sh` and `redactor.sh` scripts to assure that the file names are standardized and the outputs are removed (to avoid data leak).
14+
1. Copy the `.ipynb` files to `notebooks/library`
15+
2. Run the `cataloguer.sh` script to normalize the file names
16+
3. Run the `redactor.sh` script to remove outputs and avoid data leakage
2017

2118
## License
2219
Distributed under the MIT License. See `LICENSE` for more information.

0 commit comments

Comments
 (0)