matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add readme file for paper

Browse source
This commit is contained in:
Matthias Beyer 2016-01-08 12:59:03 +01:00
parent fd541c3270
commit 21947496d3
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/README.md Normal file
View file

@ -0,0 +1,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.