diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 000000000..f07f16d97 --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,67 @@ += JBake +Jonathan Bullock +2013-10-20 +:idprefix: + +http://jbake.org[JBake] is a Java based open source static site/blog generator for developers. + +image::https://travis-ci.org/jonbullock/JBake.png?branch=master[Build Status, link="https://travis-ci.org/jonbullock/JBake"] + +== Documentation + +Full documentation is available on http://jbake.org/docs/[jbake.org]. + +== Maven + +You can run directly from the source code using the Maven exec plugin: + +---- +mvn exec:java -Dexec.mainClass=org.jbake.launcher.Main -Dexec.args="/fromFolder /tmp/toFolder/" +---- + +== Contributing + +Coming soon... + +== Versioning + +The project has adopted the http://semver.org[Semantic Versioning] spec from v2.2.0 onwards to maintain an +understandable backwards compatibility strategy. + +The version format is as follows: + +---- +..-