Skip to content

(READ ONLY MIRROR) ProB 2 Documentation

Notifications You must be signed in to change notification settings

hhu-stups/prob2-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ProB 2.0 Handbook

Repository for the ProB 2.0 Handbook.

Building

Assuming you have all necessary dependencies installed (see below), run:

$ make

The documentation will be built in HTML and PDF format and output into the build directory.

Dependencies

The build requires Asciidoctor with the BibTeX, diagram, and PDF extensions. These dependencies are available in most package managers and as a Docker image asciidoctor/docker-asciidoctor.

You can also use an existing Ruby installation and Bundler to install the dependencies:

$ bundle config set --local path vendor/bundle
$ bundle install

Then use bundle exec make to run the build.