opensource/bpmn-js
1
0
Fork 0
mirror of https://github.com/bpmn-io/bpmn-js.git synced 2025-08-26 04:32:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

style: re-format markdown

Browse Source
This commit is contained in:
Nico Rehwaldt
2023-01-09 11:50:47 +01:00
committed by Nico Rehwaldt
parent 81799261b8
commit 18a045790d
3 changed files with 5 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -47,7 +47,6 @@ _Re-release of `v11.0.2`._
* New popup menu UI introduced with `diagram-js@11`. See [`diagram-js` breaking changes and migration guide](https://github.com/bpmn-io/diagram-js/blob/develop/CHANGELOG.md#breaking-changes).
* Keyboard-related features no longer use `KeyboardEvent#keyCode`. Use a polyfill (e.g. [keyboardevent-key-polyfill](https://www.npmjs.com/package/keyboardevent-key-polyfill)) if you need to support old browsers.
## 10.3.0
* `FEAT`: add BPMN specific space tool ([#1344](https://github.com/bpmn-io/bpmn-js/pull/1344))

8
README.md
View File

@ -6,7 +6,6 @@ View and edit BPMN 2.0 diagrams in the browser.
[![bpmn-js screencast](./resources/screencast.gif "bpmn-js in action")](http://demo.bpmn.io/s/start)
## Installation
Use the library [pre-packaged](https://github.com/bpmn-io/bpmn-js-examples/tree/master/pre-packaged)
@ -36,7 +35,6 @@ try {
Checkout our [examples](https://github.com/bpmn-io/bpmn-js-examples) for many
more supported usage scenarios.
### Dynamic Attach/Detach
You may attach or detach the viewer dynamically to any element on the page, too:
@ -51,7 +49,6 @@ viewer.attachTo('#container');
viewer.detach();
```
## Resources
* [Demo](http://demo.bpmn.io)
@ -60,7 +57,6 @@ viewer.detach();
* [Forum](https://forum.bpmn.io)
* [Changelog](./CHANGELOG.md)
## Build and Run
Prepare the project by installing all dependencies:
@ -85,7 +81,6 @@ npm run dev
You may need to perform [additional project setup](./docs/project/SETUP.md) when
building the latest development snapshot.
## Related
bpmn-js builds on top of a few powerful tools:
@ -93,18 +88,15 @@ bpmn-js builds on top of a few powerful tools:
* [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle): Read / write support for BPMN 2.0 XML in the browsers
* [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit
## Contributing
Please checkout our [contributing guidelines](./.github/CONTRIBUTING.md) if you plan to
file an issue or pull request.
## Code of Conduct
By participating to this project, please uphold to our [Code of Conduct](https://github.com/bpmn-io/.github/blob/master/.github/CODE_OF_CONDUCT.md).
## License
Use under the terms of the [bpmn.io license](http://bpmn.io/license).

15
docs/project/SETUP.md
View File

@ -2,16 +2,13 @@
This document describes the necessary steps to setup a `bpmn-js` development environment.
## TLDR;
On Linux, OS X or Windows? [git](http://git-scm.com/), [NodeJS](nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) ready? Check out the [setup script section](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/SETUP.md#setup-via-script) below.
On Linux, OS X or Windows? [git](http://git-scm.com), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) ready? Check out the [setup script section](#setup-via-script) below.
## Manual Steps
Make sure you have [git](http://git-scm.com/), [NodeJS](nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) installed before you continue.
Make sure you have [git](http://git-scm.com), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) installed before you continue.
### Get Project + Dependencies
@ -23,7 +20,7 @@ The following projects from the [bpmn-io](https://github.com/bpmn-io) project on
and clone them into a common directory via
```
```sh
git clone git@github.com:bpmn-io/bpmn-js.git
git clone git@github.com:bpmn-io/diagram-js.git
git clone git@github.com:bpmn-io/bpmn-moddle.git
@ -33,7 +30,7 @@ git clone git@github.com:bpmn-io/bpmn-moddle.git
[Link dependent projects](https://docs.npmjs.com/cli/link) between each other to pick up changes immediately.
```
```plain
.
├─bpmn-js
│ └─node_modules
@ -55,12 +52,10 @@ Use `mklink /d <link> <target>` [(docs)](http://technet.microsoft.com/en-us/libr
Execute `npm install` on each of the projects to grab their dependencies.
### Verify Things are O.K.
Execute `npm run all` on each project. Things should be fine.
### Setup via Script
The whole setup can be automated through setup scripts for [Linux/OS X](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.sh) and [Windows](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.bat).
The whole setup can be automated through setup scripts for [Linux/OS X](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.sh) and [Windows](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.bat).