From e17e6a0c3dd14ae96726a5b495eb6bc93bfc7e05 Mon Sep 17 00:00:00 2001 From: Robert Reiz Date: Sun, 18 Feb 2024 14:21:53 +0100 Subject: [PATCH] Some improvements for the README.md. --- README.md | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3a58775e..b60a361e 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,31 @@ Mustangproject Source code repository for the [Mustang project](http://www.mustangproject.org/) open source java PDF invoice metadata library in ZUGFeRD format. -License +Build ----- -Subject to the Apache license http://www.apache.org/licenses/LICENSE-2.0.html +These are the recommended dependencies for the project: -Running ------ + - OpenJDK 21.0.2 2024-01-16 + - Apache Maven 3.9.6 -This project requires Maven to run. Build project with "mvn clean install". This will build the project, test it and install the artifacts to local cache. After that the mustang jar can be used. +You can build the project with: -More information in [the mustang documentation](https://github.com/ZUGFeRD/mustangproject/blob/master/doc/ZugferdDev.en.pdf?raw=true). +```shell +mvn clean install +``` + +This will run the tests, build the project artefacts, and install the artifacts to the local +cache. After that the mustang JAR can be used. + +More information on how to develop **on** mustang: + + - [Developer documentation](https://github.com/ZUGFeRD/mustangproject/blob/master/doc/development_documentation.md) Usage ----- -If you setup a Maven project, you can grab the artifacts using +If you set up a Maven project, you can reference the mustang artifact like this: ```xml @@ -29,8 +38,19 @@ If you setup a Maven project, you can grab the artifacts using ``` +Further docs on how to develop **with** mustang: + + - [ZugferdDev.en.pdf](https://github.com/ZUGFeRD/mustangproject/blob/master/doc/ZugferdDev.en.pdf?raw=true): the English mustang user documentation. + - [ZugferdDev.de.pdf](https://github.com/ZUGFeRD/mustangproject/blob/master/doc/ZugferdDev.de.pdf?raw=true): the German mustang user documentation. + - [Usage examples](https://www.mustangproject.org/use/): Read and write electronic invoices. + - [Mustang classes](https://www.mustangproject.org/invoice-class/): Using the mustang classes. + Contact ----- Developer: Jochen Stärk. For questions please contact Jochen at jstaerk [at] usegroup.de +License +----- + +Subject to the [Apache-2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html).