huh

Author: heyzec

docs/README.md

@@ -1,70 +1,23 @@
-# Developer Guide
+# Notes to developers
 
-We place developer-facing stuff here because the README.md in the root will be displayed on VS Code Marketplace.
+## Running the extension in dev mode
 
-## Setting up project locally
-1. Clone this repo
-2. Assume yarn installed. Assume node installed.
-
-For Nix users, step 2
-- If you have nix-direnv installed, no need anything
-- Else, enter with nix develop
-
-## Running the extension (in?)
 1. Setup the project
    ```
    yarn
    ```
 1. Compile
-   ```sh
+   ```
    yarn compile
    ```
-1. Run the extension in debug mode by opening the root folder in VS Code, then "Start Debugging" (or press F5). Under the hood, this is will compile the extension by running `yarn compile`.
-
-Alternatively, install a compiled version of the extension.
-
-```sh
-yarn compile
-code --profile "Default" --install-extension source-academy-*.vsix --force
-```
+1. Run the extension in debug mode by opening the root folder a VSCode window, then "Start Debugging" (or press F5).
 
 ## Publishing the extension
 
 For a new release, update the version in `package.json` and tag the commit. Push the commit and the tag to the repo,
 which will trigger GitHub Actions to build and publish the extension to Releases tab and the Marketplace.
 
-```sh
+```
 npm version (major|minor|patch)
 git push origin main --tags
 ```
-
-What else?
-- Key points from my FYP report, including architecture
-- For extension: tip to console.log, using debugger
-- Instructions for local frontend (tip: how to log), and for LSP (tip: how to log)
-- ensure vscode version
-```
-"engines": {
-    "vscode": "^1.93.0"
-  },
-```
-
-it is my beleif that we should have good dev experience
-
-note to developers: if following vscode debug setup doesn't work, this is a documentation bug. if you are sure you followed the steps correctl,y please raise an issue
-
-it is my beleif that we should have good dev experience
-
-iamge to readme, user facing
-
-About debuggin in vscode is supported for VS Code, but not neovim.
-
-add exrc for neovim
-
-sugested extensions: both to user and to developer
-
-## Archi
-Delegation to frontend
-js-slang in frontend
-Extension context and Webview context
-Drawing from STEPS