Yet Another Static Site (Generator) Documentation

Table of Contents

• Requirements
• Build from sources

Requirements

To run the program or build it from the sources you need libcmark library which should be available in most Linux distributions. If not, you can download it source code from GitHub. Please refer to it documentation on how to compile it.

If you use downloaded AppImage version of the program, you don't need any other dependencies. More informations about using AppImage files you can find in AppImage documentation

^ Top

Build from sources

Preparations

To build YASS from the source you will need few things:

• Ada compiler - GCC with enabled Ada support or (best option) GNAT from: AdaCore

• gprbuild - it is included in GNAT and should be available in most Linux distributions too.

• Ada Web Server (AWS) - if you use GNAT from AdaCore it is included in package. In other situations, you may need to download it from: AdaCore or GitHub

Build program

Navigate to the main directory to compile:

• Easiest way to compile the program is use Gnat Programming Studio included in GNAT. Just run GPS, select yass.gpr as a project file and select option Build All.

• If you prefer using console: in main source code directory type gprbuild for debug mode build or for release mode: gprbuild -XMode=release. If you have installed Bob you can type bob debug for build in debug mode or bob release to prepare release for the program.

If you want to be able to print content of README.md file to terminal (by readme program command), copy file README.md to bin directory.

Note: If you want to move the program around, compile it in release mode. In debug mode the program may have problems with finding all dependencies.

Build unit tests

Navigate to tests/driver directory from the main directory (where this file is):

• From console: type gprbuild -P test_driver.gpr

Or if you have Bob installed, type bob tests.

^ Top