Skip to content

Commit

Permalink
feat(doc): clarify content in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abirembaut committed May 11, 2021
1 parent d730287 commit 2734973
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,24 @@

This repository aggregates all the community development artifacts of the Bonita User Application

## Development

* /applications contains the .bos version of the app descriptor. In this version, the UID pages tokens contain the version of the page because the UID pages are rebuilt by Bonita Studio when deploying the pages and so the pages token must match the page tokens declared in the page.properties generated by the UID (custompage_*).
* /bonita-distrib contain the distribution version of the app descriptor. In the distribution, page.properties do not contain the version of the page. This way, in the apps we provide there is no migration step required on the apps when the page has been updated in the new version.

## Build

Run `./mvnw clean verify` in a terminal. The result of the build is a BOS Archive in the `target` folder.
Run `./mvnw clean verify` in a terminal. The result of the build is in the `target` folder:
* a .bos archive to import in Bonita Studio
* a zip file containing the application descriptor and the application icon
* a zip "with-resources" containing the application descriptor, icon and the pages it relies on

## Application content
## .bos Application content

* An application descriptor for the Bonita User Application
* The Bonita layout as a development artifact
* The Case page as a development artifact
* The UID pages as a development artifact
* The Task list and Process list application pages are not designed with the UI Designer and are already embedded in the Runtime bundle.

## Customize the theme in Enterprise editions

In addition to development pages, you may also customize the default Bonita theme just by creating a new Theme in the Studio.
By the default the Bonita theme is used as starting point, so you just have to update the theme id in the application descriptor with your custom theme id.
By the default the Bonita theme is used as starting point, so you just have to update the theme id in the application descriptor with your custom theme id.

0 comments on commit 2734973

Please sign in to comment.