diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/planemo/lib/python3.7/site-packages/schema_salad/java/README.md	Fri Jul 31 00:32:28 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