Mercurial > repos > shellac > guppy_basecaller
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/env/lib/python3.7/site-packages/schema_salad/java/README.md Thu May 14 14:56:58 2020 -0400 @@ -0,0 +1,36 @@ +# ${project_name} + +${project_description} + +## License + +This project is licensed under the [${license_name}](${license_url}). + +## Contributing + +This project is auto-generated by [Schema Salad](https://github.com/common-workflow-language/schema_salad) +and likely should not be modified directly. Instead consider filing an issue or opening +a pull request against the Schema Salad repository. + +## Requirements + +This Java library requires Java 8+. Building and testing this project requires +[Apache Maven](https://maven.apache.org/) (``mvn``). + +## Usage + +Compile the project, test it, and build a jar + + $ mvn install + $ ls target/ # jar file in here + +Building a standalone jar with all dependencies included and use it to validate a document + + $ mvn install + $ mvn assembly:single + $ java -jar target/<project_name>-0.0.1-SNAPSHOT-jar-with-dependencies.jar ../path/to/document.yml + +Building and viewing JavaDocs + + $ mvn javadoc:javadoc + $ open target/site/apidocs/index.html