Mercurial > repos > shellac > guppy_basecaller
comparison env/lib/python3.7/site-packages/schema_salad/java/README.md @ 2:6af9afd405e9 draft
"planemo upload commit 0a63dd5f4d38a1f6944587f52a8cd79874177fc1"
| author | shellac |
|---|---|
| date | Thu, 14 May 2020 14:56:58 -0400 |
| parents | 26e78fe6e8c4 |
| children |
comparison
equal
deleted
inserted
replaced
| 1:75ca89e9b81c | 2:6af9afd405e9 |
|---|---|
| 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 |