openremise.github.io

openremise.github.io contains the source code for the OpenRemise website. It serves as the public landing page and information hub for the OpenRemise project, providing an introduction, a getting started guide and links to further documentation.

Table of Contents

1. Features
2. Getting Started
• Prerequisites
• Build

Features

• Uniform look for landing page and project documentation
• Modern look despite Doxygen due to Doxygen Awesome
• No ads, no tracking or other B$

Getting Started

Prerequisites

• CMake ( >= 3.25 )
• graphviz ( >= 14.0.0 )
• openjdk ( >= 21 )

Build

The website gets published automatically with each push to the master branch through the docs workflow. However, it is also possible to build the site locally if the prerequisites are installed.

cmake --preset "Release"
cmake --build build --parallel --target OpenRemiseDocs

If the build was successful, the website can be viewed simply with a browser by opening build/docs/html/index.html or by creating a small web server.

python -m http.server --directory build/docs/html --bind 127.0.0.1