Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Clarified Contributing section, as per #35
  • Loading branch information
drscotthawley authored Jan 5, 2024
1 parent cd953bd commit de9a85a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,15 @@ documentation! To contribute:
4. [Install nbdev](https://nbdev.fast.ai/getting_started.html#install)
and then you can edit the Jupyter notebooks.

5. After editing notebooks, run `nbdev_prepare`
** **NOTE:** Edit the notebook (`.ipynb`) files, *not* the `.py` files, as the latter get overwritten by `nbdev`.

6. If that succeeds, you can do
6. After editing notebooks, run `nbdev_prepare`

7. If that succeeds, you can do
`git add *.ipynb aeiou/*.py; git commit` and then `git push` to get
your changes to back to your fork on GitHub.

7. Then send a Pull Request from your fork to the `dev` branch of this original `aeiou`
8. Then send a Pull Request from your fork to the `dev` branch of this original `aeiou`
repository.

## Attribution
Expand Down

0 comments on commit de9a85a

Please sign in to comment.