Adds build instructions.

This commit is contained in:
Henning Dieterichs
2020-02-25 12:28:18 +01:00
parent 78a133505c
commit f55bef23c2
3 changed files with 33 additions and 2 deletions

View File

@@ -6,3 +6,26 @@ See the [extension](extension) directory for the extension readme.
You can get the extension in the [marketplace](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer).
![](./docs/doubly-linked-list-reverse-demo.gif)
## Build Instructions
- Clone the repository
- Run `yarn` in the repository root
- Run `yarn build`
## Dev Instructions
- Clone the repository
- Run `yarn` in the repository root
- Run `yarn build` initially (or `yarn dev` for every project)
- Run `yarn dev` **inside** the project you are working on.
For the UI, `yarn dev` will start a webserver that you can access on port 8080.
You can use VS Code do launch and debug the extension.
Chose `Run Extension (Dev UI)` as debug configuration so that the extension loads the UI from the webpack server.
## Publish Instructions
- Follow the Build Instructions
- `cd extension`
- `yarn pub`

View File

@@ -5,5 +5,12 @@
"./data-extraction",
"./extension",
"./extension/ui"
]
],
"scripts": {
"build": "yarn build-data-extraction && yarn build-shared && yarn build-extension && yarn build-ui",
"build-data-extraction": "yarn workspace @hediet/debug-visualizer-data-extraction build",
"build-shared": "yarn workspace @hediet/debug-visualizer-vscode-shared build",
"build-extension": "yarn workspace debug-visualizer build",
"build-ui": "yarn workspace debug-visualizer-ui build"
}
}

View File

@@ -14,7 +14,8 @@
"src"
],
"scripts": {
"dev": "tsc --watch"
"dev": "tsc --watch",
"build": "tsc"
},
"dependencies": {
"@hediet/std": "^0.6.0",