From dd8b4a34a78448182144b188b69683005ce7e1ac Mon Sep 17 00:00:00 2001 From: Maksim Rakitin Date: Sun, 15 Jul 2018 10:11:51 -0500 Subject: [PATCH] DOC: extending README.md with the development section --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 14e6141..ec889ab 100644 --- a/README.md +++ b/README.md @@ -138,3 +138,22 @@ and under the GitHub settings add ``` where `owner` is the GitHub user/org, and `repository` is the name of the repository you want to open. + +## Development + +For a development install, do the following in the repository directory: + +```bash +jlpm install +jlpm run build +jupyter labextension link . +``` + +You can then run JupyterLab in developer mode to automatically pick up changes +to `@jupyterlab/github`. Launch JupyterLab using +```bash +jupyter lab --watch +``` +This will automatically recompile `@jupyterlab/github` upon changes, and +JupyterLab will rebuild itself. You should then be able to refresh the page and +see your changes.