comparison planemo/lib/python3.7/site-packages/schema_salad/java/README.md @ 1:56ad4e20f292 draft

"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"
author guerler
date Fri, 31 Jul 2020 00:32:28 -0400
parents
children
comparison
equal deleted inserted replaced
0:d30785e31577 1:56ad4e20f292
1 # ${project_name}
2
3 ${project_description}
4
5 ## License
6
7 This project is licensed under the [${license_name}](${license_url}).
8
9 ## Contributing
10
11 This project is auto-generated by [Schema Salad](https://github.com/common-workflow-language/schema_salad)
12 and likely should not be modified directly. Instead consider filing an issue or opening
13 a pull request against the Schema Salad repository.
14
15 ## Requirements
16
17 This Java library requires Java 8+. Building and testing this project requires
18 [Apache Maven](https://maven.apache.org/) (``mvn``).
19
20 ## Usage
21
22 Compile the project, test it, and build a jar
23
24 $ mvn install
25 $ ls target/ # jar file in here
26
27 Building a standalone jar with all dependencies included and use it to validate a document
28
29 $ mvn install
30 $ mvn assembly:single
31 $ java -jar target/<project_name>-0.0.1-SNAPSHOT-jar-with-dependencies.jar ../path/to/document.yml
32
33 Building and viewing JavaDocs
34
35 $ mvn javadoc:javadoc
36 $ open target/site/apidocs/index.html