From 6b9ac6c1149d201b46ec1d5f34060d64e1aec8b2 Mon Sep 17 00:00:00 2001 From: rocky Date: Sun, 16 Feb 2025 11:11:35 -0500 Subject: [PATCH 1/2] Add basic install instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 1c16067..f776aa0 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,15 @@ JupyterLite is being tested against modern web browsers: - Firefox 90+ - Chromium 89+ +## Installing and running locally + +```bash +python3 -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt +make serve +``` + ## Further Information and Updates For more info, keep an eye on the JupyterLite documentation: From e2c3a047422a7a1edb4f55f1ad089ba4cba19e96 Mon Sep 17 00:00:00 2001 From: rocky Date: Sun, 16 Feb 2025 12:32:51 -0500 Subject: [PATCH 2/2] Note one-time setup steps vs. server start --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f776aa0..1757b35 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,18 @@ JupyterLite is being tested against modern web browsers: ## Installing and running locally +Install this code in a virtual Python environment: ```bash python3 -m venv .venv source .venv/bin/activate pip install -r requirements.txt +``` + +The above needs to be done only once. + +Once the virtual environment has been set up with the packages installed, to run the server: + +```bash make serve ```