Commit Graph

3 Commits

Author SHA1 Message Date
Paul Barker
371f85ce53 docs: Format all links correctly
Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-05-26 12:16:52 +01:00
Mirza Krak
34113350f4 docs: fix alignment of "code blocks"
We provide a lot of variable examples as code blocks in the following
format:

	some text: `Variable`

or
	some test:
	`Variable`

Which is not as pretty as (when converted to html/pdf):

	some text:

		Variable

Converted all and hoppefully this will improve readability a bit.

Signed-off-by: Mirza Krak <mirza.krak@endian.se>
2017-05-26 12:16:52 +01:00
Paul Barker
03976f7ff1 docs: Initial split of README into docs directory
The top-level README document has got pretty unwieldy and so we need to
switch to add some more structure to our documentation. The first step
is to split out sub-sections of the README document into separate files
in a new 'docs' directory.

Whilst splitting up the README, we can also take the opportunity to tidy
things up and fix a couple of typos.

Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-05-26 12:16:52 +01:00