imag/doc
Matthias Beyer eca7219039 Rewrite configuration providing in runtime
Before the configuration object (the raw TOML object) was provided via a
wrapper object `Configuration`. This was ugly and not very nice to use.

Now, we only have the `toml::Value` object we lend out from
`Runtime::config()`.

The changes included libimagrt internal rewrites, which are not visible
to the user. Anyways, this change changes the API for config-fetching
from the runtime, so fixes for all other crates may follow.

The changes also removed the support for reading the "editor" setting
from the configuration file, which was not used anyways (in the example
imagrc.toml file).
The CLI-reading and ENV-reading are still supported, though.
2017-10-31 09:25:14 +01:00
..
src Rewrite configuration providing in runtime 2017-10-31 09:25:14 +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
Makefile Define tasks for manpage generation 2016-07-03 13:27:11 -04:00
README.md Add readme file for paper 2016-01-08 13:12:55 +01:00
default.nix Add missing dependency: which 2016-07-30 20:59:49 +02:00

README.md

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.