matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: Update README

Browse source
This commit is contained in:
Matthias Beyer 2018-06-11 14:55:33 -03:00
parent 33789a0da8
commit f9294eb07a
1 changed files with 1 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/README.md
View file

@ -3,19 +3,5 @@
This subdirectory contains the documentation of the basic idea behind ``imag''. 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. It is written in Markdown and compiled to both PDF and HTML via pandoc.
# Contributing to this paper Make sure you use pandoc `1.10+` if you want to build the 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.