Chore: update Readme with dev scripts

Added development setup instructions and scripts usage.
pull/7775/head
Luigi 5 months ago committed by GitHub
parent 7252e4a30d
commit 24b063bc41
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -17,6 +17,37 @@ It is built on a modernized fork of Jupyter Notebook.
![Jupyter notebook example](docs/resources/running_code_med.png 'Jupyter notebook example')
## Development
Developer experience is simple and clean relative to the upstream fork.
To setup and build your development enviroment:
```sh
./scripts/rebuild.sh
```
To start the notebook development server from your code:
```sh
./scripts/dev.sh
```
The notebook server will run on port: 8888.
In another terminal to watch for changes w/ auto hot reloading:
```sh
./scripts/watch.sh
```
To cleanly rebuild your environment from scratch:
```sh
./scripts/rebuild.sh
```
## Installation (Coming Soon)
You can find the installation documentation for the

Loading…
Cancel
Save