evolution-docs/README.md

864 B

Evolution Docs

Welcome to the EvolutionOS documentation. This repository contains the source data behind https://hectabit.org/evolutionos/wiki/. Contributing to this repository follows the same protocol as the packages tree. For details, please read CONTRIBUTING.

Building

The res/build.sh script builds HTML, roff and PDF versions of the EvolutionOS documentation and the evolution-docs.1 man page. It requires the following EvolutionOS packages:

  • mdBook
  • findutils or busybox + evolution-patches
  • lowdown (version 0.8.1 or greater)
  • texlive
  • perl
  • perl-File-Which
  • perl-JSON
  • librsvg-utils
  • python3-md2gemini

In order to build and install these files, set the PREFIX and DESTDIR environment variables to appropriate values and run res/build.sh followed by res/install.sh.