README ====== This README describes the generation of the user documentation for VECTO. The documents are written in Markdown (pandoc markdown, Extension: .md). To generate the final documentation execute "convert.bat". The resulting files are stored in the respective "output"-directory (output/html, output/pdf). The included files and their order is defined in the file "files.txt". Requirements ------------ * pandoc: http://pandoc.org/ Directory Structure --------- * README.txt: this readme file. * convert.bat: the script to convert the markdown files into the required formats. * files.txt: the list of files which should be used (also defines the order). * fileformat: contains the .md files regarding the input/output files * general: contains the .md files regarding general concepts * GUI: contains the .md files regarding the graphical user interface * pics: contains all pictures * output: directory for the generated files. HTML ---- * katex: javascript framework for formulas * style.css: stylesheet PDF --- * latex must be installed
Forked from
VECTO / VECTO Sim
Source project has a limited visibility.
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
| Name | Last commit | Last update |
|---|---|---|
| .. | ||
| GUI | ||
| fileformat | ||
| general | ||
| main | ||
| output/html | ||
| pics | ||
| README.txt | ||
| convert.bat | ||
| files.txt | ||
| include.js | ||
| usermanual.html | ||