diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index b8b01492c71c5a2bd2fd140593feb8a76fd27558..a64ee8fb1f094f3bc98d65b87ec697d24e8654db 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -60,26 +60,45 @@ reset VS Code then run `yarn vscode:patch`. ## Build +You can build with: + +```shell +./ci/steps/release.sh +``` + +Run your build with: + +``` +cd release +yarn --production +# Runs the built JavaScript with Node. +node . +``` + +Build release packages (make sure you run `./ci/steps/release.sh` first): + +``` +./ci/steps/release-packages.sh +# The standalone release is in ./release-standalone +# .deb, .rpm and the standalone archive are in ./release-packages +``` + +The `release.sh` script is the equivalent of: + ```shell yarn yarn vscode yarn build yarn build:vscode yarn release -cd release -yarn --production -# Runs the built JavaScript with Node. -node . ``` -Now you can build release packages with: +And `release-packages.sh` is: ``` yarn release:standalone -# The standalone release is in ./release-standalone yarn test:standalone-release yarn package -# .deb, .rpm and the standalone archive are in ./release-packages ``` ## Structure