Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eigenvivek authored Nov 26, 2023
1 parent 139e843 commit 98522ca
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ optimization runs like this:
The full example is available at
[`optimizers.ipynb`](https://vivekg.dev/DiffDRR/tutorials/optimizers.html).

## Development (optional)
## Development

`DiffDRR` source code, docs, and CI are all built using
[`nbdev`](https://nbdev.fast.ai/). To get set up with `nbdev`, install
Expand All @@ -112,7 +112,9 @@ important ones are

``` zsh
nbdev_preview # Render docs locally and inspect in browser
nbdev_prepare # NECESSARY BEFORE PUSHING: builds package, tests notebooks, and builds docs in one step
nbdev_clean # NECESSARY BEFORE PUSHING
nbdev_test # tests notebooks
nbdev_export # builds package and builds docs
```

For more details, follow this [in-depth
Expand Down

0 comments on commit 98522ca

Please sign in to comment.