Skip to content
Snippets Groups Projects
Verified Commit 479bd440 authored by ck85nori's avatar ck85nori :railway_track:
Browse files

adds features section to readme

parent 31e3d12d
Branches
No related tags found
No related merge requests found
Checking pipeline status
Change to Document Title Here
=============================
A flexible and future proof way to write documents.
Features
--------
This project template and its build is quite flexible. The template strives to
provide a more or less complete example of what is possible to keep not just
the text under version control but also other sources like flowcharts and
plots. Flexibility also means that you can add any feature you see fit or opt
out of features you don't need.
The default features include:
- write document in [pandoc][]-flavored Markdown, the example sources include
- a Markdown guide
- how to use inline LaTeX
- how to insert tables from CSV files
- how to insert flowcharts generated via [Graphviz][] from `.dot` sources
- how to insert plots generated with [R][] from CSV sources
- a build script (`Makefile`) to automate the build process
- convert Markdown sources to PDF with [pandoc][]
- continuous integration, i.e. a build server that automatically
- spell checks Markdown sources
- deploys document to [Nextcloud][idiv-nc] share
### Disabling Features
You can remove some features just by removing the respective content in the
Markdown sources.
- **plots:** remove the `*.R` file(s) in `img/plot`
- **flowcharts:** remove the `*.dot` file(s) in `img/graph`
Continuous Integration
----------------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment