Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
css
css
 
 
images
images
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
asciidoc.conf
asciidoc.conf
 
 
contributing.txt
contributing.txt
 
 
design_concept_map.txt
design_concept_map.txt
 
 
design_ideas.txt
design_ideas.txt
 
 
design_principles.txt
design_principles.txt
 
 
design_types.txt
design_types.txt
 
 
dev_bugtracking.txt
dev_bugtracking.txt
 
 
dev_compiler_internals.txt
dev_compiler_internals.txt
 
 
dev_howto_make_pr.txt
dev_howto_make_pr.txt
 
 
dev_maintainers.txt
dev_maintainers.txt
 
 
dev_mercury_grades.txt
dev_mercury_grades.txt
 
 
dev_style_c.txt
dev_style_c.txt
 
 
dev_style_mercury.txt
dev_style_mercury.txt
 
 
dev_testing.txt
dev_testing.txt
 
 
getting_started.txt
getting_started.txt
 
 
index.txt
index.txt
 
 
plasma_ref.txt
plasma_ref.txt
 
 
pz_machine.txt
pz_machine.txt
 
 
references.txt
references.txt
 
 
user_guide.txt
user_guide.txt
 
 

README.md

Documentation

We're assuming you are running Linux. For Mac it will probably be similar. Since Plasma is currently not supported on Windows, building the docs on that platform is also not documented.

You will need a working copy of AsciiDoc on your PC to build the documentation. For Ubuntu, it is simply a matter of typing

sudo apt-get install asciidoc source-highlight

For Fedora:

sudo dnf install asciidoc

For other distros, check your package manager.

You also need to install source-highlight to get the C code properly highlighted. Your package manager should also have this.

With these installed, you should be set.

To build the documentation type make docs in the project's top-level directory. This will generate the HTML output.