Some doc changes to help you get started.

o19s · Feb 8, 2024 · 3ff16df · 3ff16df
1 parent 0b58ce3
commit 3ff16df
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+
+# created by unzipping the jupyter-lite-build.tgz
+notebooks/
+
 # VIM swp
 *.swp
 
@@ -25,4 +29,4 @@ public/notebooks-*
 .jupyterlite.doit.db
 
 # Built artifact
-jupyter-lite-build.tgz
+jupyter-lite-build.tgz
diff --git a/README.md b/README.md
@@ -16,3 +16,10 @@ which also add the build artifact as a release asset.
 * Check [requirements.txt](./jupyterlite/requirements.txt) and [jupyter_lite_config.json](./jupyterlite/jupyter_lite_config.json) for library updates
 * Check [Dockerfile](./Dockerfile) for Pyodide updates
 
+## Development
+
+Unzip the TGZ file which will then unpack into `./notebooks`.  
+
+Run either `python -m http.server 8000 --directory ./notebooks` or `ruby -run -ehttpd ./notebooks -p 8000`
+
+Browse to http://localhost:8000 and you should see the Jupyterlite interface.