From 98522ca88bb9387a5152d3cdc343801923f6cd05 Mon Sep 17 00:00:00 2001 From: Vivek Gopalakrishnan <vivekg@mit.edu> Date: Sun, 26 Nov 2023 10:58:00 -0500 Subject: [PATCH] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4bcb37e0c..e5f8220f5 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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