diff --git a/README.md b/README.md index 18d5880..35728e6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,41 @@ This module is used to generate a 'concatenated' notebook for use in an LSP based language server. +### Directions for building + +You might want to setup an npm link for the jupyter repository + +- git clone https://github.com/microsoft/vscode-jupyter.git +- git clone https://github.com/microsoft/vscode-jupyter-lsp-middleware.git +- git clone https://github.com/microsoft/lsp-notebook-concat.git +- cd lsp-notebook-concat +- npm link (sets up linking to this module) +- cd ..\vscode-jupyter-lsp-middleware +- npm link @vscode/lsp-notebook-concat (the name of the lsp-notebook-concat module in npm) +- npm link (set up linking to this module for vscode-jupyter) +- cd ..\vscode-jupyter +- npm link @vscode/jupyter-lsp-middleware (the name of the vscode-jupyter-lsp-middleware module in npm) + +Then to build vscode-jupyter-lsp-middleware + +- npm run download-api (updates vscode.d.ts) +- npm run webpack (which will setup stuff for using with vscode-python) + +### Directions for debugging with jupyter extension + +- Run the steps above for getting the npm link setup +- From with VS code, open both jupyter, lsp-middleware, and lsp-notebook-concat as three folders +- Build the 'webpack link' task for lsp-notebook-concat +- Build the 'webpack link' task for lsp-middleware +- Build the compile task for jupyter +- Set breakpoints in the dist/index.js file while debugging (it's a development webpack) +- Edit lsp code +- Rerun the 'webpack link' build every time (it doesn't watch as it runs a post build step) + +### Directions for running tests + +- npm run tests (builds and runs tests) + ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a