Skip to content

Commit

Permalink
docs: improve README
Browse files Browse the repository at this point in the history
Improve the "implementations" paragraph
Fix badge of the build status
  • Loading branch information
tbouffard authored Aug 22, 2024
1 parent 0cc614b commit 1bb66d5
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
</a>
<a href="https://travis-ci.com/process-analytics/bpmn-layout-generators">
<img alt="Build" src="https://travis-ci.com/process-analytics/bpmn-layout-generators.svg?branch=master">
</a>
</a>
<a href="https://github.com/process-analytics/bpmn-layout-generators/actions/workflows/build-java.yml">
<img alt="Build" src="https://github.com/process-analytics/bpmn-layout-generators/workflows/Build%20Java/badge.svg">
</a>
<br>
<!-- no CONTRIBUTING guide available for now
<a href="CONTRIBUTING.md">
Expand All @@ -28,16 +31,17 @@ Tools for generating the graphical layout of the BPMN process (BPMNDI Graphical
They can be used with diagrams containing only the BPMN Semantic part or to replace the existing BPMNDI part.


Plan work for the 1st implementations
- based or partially based on https://www.researchgate.net/publication/221542866_A_Simple_Algorithm_for_Automatic_Layout_of_BPMN_Processes
- will be implemented in `Java`. If it works, `javascript`/`TypeScript` and `R` implementations will be done


## Implementations

> [!NOTE]
> The implementations are based or partially based on https://www.researchgate.net/publication/221542866_A_Simple_Algorithm_for_Automatic_Layout_of_BPMN_Processes
Available implementations:
- [java](java/README.md)
- [R](R/bpmnLayoutGeneratoR/README.adoc) This is only a wrapper of the java library


## Existing alternatives

Java
Expand All @@ -48,6 +52,7 @@ Java
Javascript
- https://github.com/bpmn-io/bpmn-auto-layout/


## License

`bpmn-layout-generators` is released under the [Apache 2.0](LICENSE) license. \
Expand Down

0 comments on commit 1bb66d5

Please sign in to comment.