imag/doc
Matthias Beyer 9fb5f453fe Rewrite entry parsing algorithm
Rewrite without regex crate.

The regex approach was broken. If the following _content_ was provided
in the entry:

    foo

    ---

    bar

The regex approach parsed the header until the "---" in the content.
This is, of course, not the way to do that.

Now, the parsing is implemented by hand. Should be faster as well,
though I don't care about this.

This fixes a severe bug.
2018-02-20 21:06:36 +01:00
..
src Rewrite entry parsing algorithm 2018-02-20 21:06:36 +01:00
templates doc: template: Add TOC 2016-07-08 21:11:28 +02:00
.gitignore Add default doc setup 2016-01-08 13:11:04 +01:00
default.nix We don't have to specify the src here 2018-01-29 09:38:32 +01:00
Makefile Rename switch for new pandoc version 2018-02-10 15:40:13 +01:00
README.md Add readme file for paper 2016-01-08 13:12:55 +01:00

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, 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.