diff --git a/README.md b/README.md index 5f9d73f..ce70bd0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # kapitan-vscode-extension VSCode Extension for Kapitan - - ### Local development: -Use the devcontainer included in this folder and +Use the devcontainer included or a GitHub Codespace and * Compile the `client` by running `npm --prefix client run compile`. * Launch the python server by running from the workspace's root ```bash @@ -14,8 +12,8 @@ Then press F5, which will open another VSCode window with the extension activate The python server runs from the original window, at the terminal you used before, and all logs appear there. If you make changes to the python code, restart the python command and reload the VSCode debugging window. -### To publish packaged extension: -Use the devcontainer included in this folder and run the following from the `./client` folder +### To publish packaged extension locally: +Use the devcontainer included or a GitHub Codespace and run the following from the `./client` folder: ```bash npm run compile npm run webpack @@ -30,4 +28,6 @@ Make sure to reload the VSCode window after installation. ### Copyright Note -The `client` folder is essentially a modified copy of the `client` folder from https://github.com/QualiTorque/torque-vs-code-extensions \ No newline at end of file +The `client` folder is essentially a modified copy of the `client` folder from https://github.com/QualiTorque/torque-vs-code-extensions + +The initial folder structure vscode setup and CI were also heavily influenced from the same repo. \ No newline at end of file