This project contains all end-user documentation for FEDEM. It consists of the following:
- LaTeX source files for the Theory Guide
- LaTeX source files for the User's Guide
- HTML source and image files as well as build script for the Reference Guide
To compile the PDF-version of the Theory and User's Guides, you need to have a LaTeX installation on your local computer. On Windows, for instance, the MiKTeX package can be used. Most Linux distributions can install a LaTeX compiler through their respective package management system.
To compile the CHM-file containing the Reference Guide (on Windows only), you need to intall the Microsoft HTML Help Workshop tool.
On Windows, you can then build the three documents by executing the bat-file make-docs.bat. To build and install the documentation in your local installation of the Fedem GUI, execute
make-docs.bat -install
It will assume you have cloned the fedem-gui
repository under %USERPROFILE%\Fedem-src and built it. If any other location,
you need to edit line 19 in the bat script defining the gui_dir variable,
or specify the desired installation folder as command-line argument:
make-docs.bat -install <doc_dir>
where <doc_dir> needs to be an existing directory.
The tree documents will be built automatically by the github action Build documentation whenever a new tag is pushed, and the resulting files are publised on the Releases page.
This project is open to feature requests, suggestions, bug reports, etc., via GitHub issues. Contributions and feedback are encouraged and always welcome. For more information about how to contribute, see our Contribution Guidelines.
Copyright 2023 SAP SE or an SAP affiliate company and fedem-docs contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.