[go: up one dir, main page]

Tobi/Doc: how to compile and install Tobi

What

This MR adds a guide to Tobi's documentation to compile and install Tobi.

Why

This knowledge is required to use Tobi.

How

This how-to guide may thus seem a bit redundant with the tutorial. But following https://diataxis.fr/ guidelines, the tutorial aims to get readers familiar with Tobi. Once they are familiar, the how-to guide is more relevant, as it is more detailed while being more to-the-point.

Manually testing the MR

You can read the markdown version in GitLab's interface. In the diff view, click on the three dots and select "View file @ (commit hash)":

image

To read the HTML version:

sudo apt-get install markdown
cd tobi/doc
make
open html/index.html

Checklist

  • Document the interface of any function added or modified (see the coding guidelines)
  • Document any change to the user interface, including configuration parameters (see node configuration)
  • Provide automatic testing (see the testing guide).
  • For new features and bug fixes, add an item in the appropriate changelog (docs/protocols/alpha.rst for the protocol and the environment, CHANGES.rst at the root of the repository for everything else).
  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR

Merge request reports

Loading