6a86a71b57
Rewrite contributing for less (boilerplate) text
2019-12-08 14:28:58 +01:00
136b4d3dd9
Reword some things on filesystem organization
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
e8f3d26a4b
Remove notes on markup implementation as not relevant here
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
a5d0cd7a74
Rewrite parts of the Header format section
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
ffa6e372e1
Prettify wording
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
9dce31edb4
Remove notes on libimagerror, as they are not relevant anymore
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
d97dfc2d52
Remove libimagerror, visualize that libimagrt is used in the full stack
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
55274ad1cd
State clearly that this shows only imag stuff
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
8c90fb59fa
State clearly that there could be more
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
9e3ce2a297
Rewrite section on crate types
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
a99c587d6c
Split intro into more files
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
4b118a4fe1
A reader should expect this to be outdated
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
0d27139cf7
Remove trailing whitespace
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:03:22 +01:00
33e53dca6d
Remove untrue paragraph
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-12-01 13:02:19 +01:00
21cc901d06
Rewrite what libimagtodo should implement
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-11-09 17:35:06 +01:00
cf78f7192f
Implement calendar library
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-10-09 19:44:08 +02:00
af6d67416b
Fix typos
2019-09-20 19:16:22 +02:00
db3bb95227
Add user documentation
...
This patch adds user documentation in for of a mdbook, using a travis
job for running the build of the book in CI to be sure it builds
properly.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-09-01 13:37:05 +02:00
d759e402a6
Add changelog for 0.9.3
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
(cherry picked from commit 6661b72e3d1a984f3010251698b7ee92be80af1a)
2019-05-25 10:43:59 +02:00
bce167d740
Update changelog for 0.9.2.
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
(cherry picked from commit d828e5fd6ff2f13c0737260649c28a8fcaab6299)
2019-05-25 10:43:59 +02:00
21b24e2d26
Remove long-term todos from doc
...
We really shouldn't have todos in the documentation.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-05-18 01:31:40 +02:00
0d9691ab0b
Update header example
2019-04-27 02:05:03 +02:00
29b04a269a
doc: Rewrite section on error handling in libraries
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-04-26 16:15:34 +02:00
3d8fef0688
Add changelog for version 0.9.1
...
This was cherry-picked from the 0.9.1 release, where I made the mistake
to add one commit for all updated stuff, instead of adding the changelog
in one commit and all other stuff in other commits.
But because we should have that information on master, we cherry-pick
the commit 7137a3ce7 partially here.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
(cherry picked from commit 7137a3ce7)
2019-04-26 16:12:23 +02:00
f84cc8169f
Revert "Remove libimagmail"
...
This reverts commit 74045e1800
.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-20 16:22:52 +01:00
74045e1800
Remove libimagmail
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-17 11:09:48 +01:00
db7121ccba
Rewrite library
...
* Remove old code
* Rewrite with tests
This implements a fassade pattern for ref library
With the fassade, we can specify the hasher in a rather easy way, which
is not possible with default generics for traits.
The "default" part in "default generic type" is not properly implemented
yet (as visible in the tests), as I don't know how to realize this.
For simplicity, the `hasher` module exports a `default` module with a
`DefaultHasher` type, which resolves to the `Sha1Hasher`.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-17 11:09:48 +01:00
a41479c0ec
doc: Rewrite README for libimagentryref
2019-02-17 11:09:48 +01:00
aa5ea533c7
Add imag-header
...
imag-header is a tool for querying information of an entry in a defined
format.
imag-header is intended for scripting with imag commands.
The output format is not stable yet, though.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-15 20:54:52 +01:00
96a25c18b2
doc: Rewrite imag-mail documentation
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:48 +01:00
73d8d54528
doc: Add notes on CLI conventions
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:45 +01:00
5775a3461a
doc: Add note that sorting in collections is no hard rule
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:42 +01:00
de8e065eec
doc: Rewrite docs for todo module parts
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-10 17:14:21 +01:00
4e516ee19d
Update version strings
...
...for the next release, which will be imag 0.10.0!
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-11-10 11:56:37 +01:00
dfba366a89
Add changelog for 0.9.0
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-11-09 22:14:11 +01:00
b3b32077a5
Remove empty section
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-11-09 21:48:26 +01:00
8552843796
doc: Add note on IO conventions
2018-11-06 20:32:34 +01:00
8c597d2c4d
doc: Document new IO story with libimagrt
2018-11-06 20:32:34 +01:00
b5c73d9c19
doc: Specify how imag-mail should look like
2018-08-26 04:24:57 +02:00
f4e0c1c5eb
doc: Add more planned commands for imag-mail
2018-08-26 04:24:57 +02:00
104cbfbfa7
doc: Format for line length
2018-08-26 04:24:57 +02:00
6ba87a58d1
Add 'Known Problems' section
2018-06-23 21:55:35 +02:00
473f962874
Update lib description
2018-06-23 21:55:35 +02:00
cb8c511985
Update lib description
2018-06-23 21:55:35 +02:00
d6a19d8645
Update lib description
2018-06-23 21:55:27 +02:00
5847987404
Remove old statement
2018-06-23 21:54:27 +02:00
869f5377f9
Update intro
2018-06-23 21:54:27 +02:00
6e45727f15
Update conventions
2018-06-23 21:54:27 +02:00
f9294eb07a
doc: Update README
2018-06-23 21:54:27 +02:00
33789a0da8
Change contributing documentation
...
For after we leave github, the documentation on how to contribute has
to be adjusted.
This patch does this.
2018-06-23 21:54:27 +02:00