summaryrefslogtreecommitdiffstats
path: root/doc/README.md
blob: b88d1fd17b6442521d9e89d1bffa740088c8e688 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Documentation of the idea

This subdirectory contains the documentation of the basic idea behind ``imag''.
It is written in Markdown and compiled to both PDF and HTML via pandoc.

# Contributing to this paper

First, the paper is not build by travis-ci. This means if there are errors, they
will be detected by me only if I build the paper. I know this is not optimal,
but as documented in [70](https://github.com/matthiasbeyer/imag/pull/70),
building the paper in travis would slow down the travis-ci machines too much.

So if you want to contribute I would like you to build the paper, if you can.
The dependencies you need are listed in the `default.nix` file (you don't need
either nix nor nixos, all of these packages should be available in all major
distros). Make sure you use pandoc `1.10+`.

Contributing to this paper is done via normal pull requests, RFC-Like.

That's all to it so far.