From 589b0e2bf9025af356917e72b8d70575eee22107 Mon Sep 17 00:00:00 2001 From: Nico Rehwaldt Date: Mon, 21 Dec 2020 13:39:14 +0100 Subject: [PATCH] docs(README): rewrite building section Now focussing on . --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ee734d2a..7dfb35f1 100644 --- a/README.md +++ b/README.md @@ -61,14 +61,25 @@ viewer.detach(); * [Changelog](./CHANGELOG.md) -## Building the Project +## Build and Run -Perform the following steps to build the library, including running all tests: +Prepare the project by installing all dependencies: -``` -cd bpmn-js +```sh npm install +``` + +Then, depending on your use-case you may run any of the following commands: + +```sh +# build the library and run all tests npm run all + +# spin up a single local modeler instance +npm start + +# run the full development setup +npm run dev ``` You may need to perform [additional project setup](./docs/project/SETUP.md) when