Home

Welcome to the Scribble Java project.

Building the project

First step is to clone the project. If you intend to modify the source (code or documentation) then first create your own fork and clone that.

git clone https://github.com/scribble/scribble-java.git

or

git clone https://github.com/<your-id>/scribble-java.git

Once you have cloned the repository, then build using:

cd scribble-java
mvn clean install

The main distributions are found in the tools folder. These are cli, which is built as a zip distribution containing the command line scripts and documentation, and eclipse which contains an update site for installation into the Eclipse Integrated Development Environment.

Contribution

This is an open source project and therefore we welcome contributions. Contributing to the project does not necessarily mean having to write code - we would also appreciate:

• feedback on the language and tooling

• reporting any issues you find

• creating feature requests if you have ideas for improvements or new functionality

• help to improve documentation

Contributing to documentation

All of the documentation for the project is written using Asciidoc. The Asciidoc cheat-sheet is a nice place to start learning about Asciidoc itself.

The documentation lives under the docs folder in the git repository. The asciidoc documentation is converted into docbook format before being generated to html and pdf. This is all performed as part of the maven build (i.e. using the mvn clean install command), which can also be run within each of the sub-folders under docs if just wanted to build an individual document after making changes.