Browse Source

Group all developer build and running instructions

Carol Willing 8 years ago
parent
commit
18f229a269
1 changed files with 38 additions and 37 deletions
  1. 38 37
      README.md

+ 38 - 37
README.md

@@ -66,7 +66,7 @@ pip install -e . # will take a long time to build everything
 jupyter serverextension enable --py jupyterlab
 ```
 
-### Running JupyterLab
+### Run JupyterLab
 Start up Jupyterlab with the command:
 
 ```bash
@@ -75,6 +75,43 @@ jupyter lab
 
 Open a browser to the notebook server's URL (e.g., `http://localhost:8888`).
 
+### Run Tests
+
+Follow the source build instructions first. Enter:
+
+```bash
+npm test
+```
+
+### Build and Run the Examples
+
+To install and build the examples in the `examples` directory:
+
+- Follow the source build instructions first.
+- Requires a Python install with the Jupyter notebook (version 4.2 or later).
+- Run the command:
+
+```bash
+npm run build:examples
+```
+
+To run an example:
+
+- Change into the specific example's directory in the `examples` directory
+- run `python main.py`
+
+### Build API Docs
+
+Follow the source build instructions first. Enter:
+
+```bash
+npm run docs
+```
+
+Navigate to `docs/index.html`.
+
+----
+
 ## High level Architecture
 
 The JupyterLab application is made up of two major parts:
@@ -143,42 +180,6 @@ npm run build:serverextension
 
 ----
 
-### Run Tests
-
-Follow the source build instructions first. Enter:
-
-```bash
-npm test
-```
-
-### Build and Run the Examples
-
-To install and build the examples in the `examples` directory:
-
-- Follow the source build instructions first.
-- Requires a Python install with the Jupyter notebook (version 4.2 or later).
-- Run the command:
-
-```bash
-npm run build:examples
-```
-
-To run an example:
-
-- Change into the specific example's directory in the `examples` directory
-- run `python main.py`
-
-
-### Build API Docs
-
-Follow the source build instructions first. Enter:
-
-```bash
-npm run docs
-```
-
-Navigate to `docs/index.html`.
-
 ----
 
 ## Publishing packages for a JupyterLab release