diff options
| author | Matthias Beyer <mail@beyermatthias.de> | 2019-12-06 20:28:27 +0100 |
|---|---|---|
| committer | Matthias Beyer <mail@beyermatthias.de> | 2019-12-08 14:28:49 +0100 |
| commit | e2d006d5639bc6ca39401f93ea21380aca1d6f86 (patch) | |
| tree | c0bea95ea3bec74db1b2e06fc86a6f4e0344b336 | |
| parent | 17d2e55bfa57b3f6a2cec1e6f30154fa06484740 (diff) | |
Rewrite README to contain less boilerplate text
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
| -rw-r--r-- | README.md | 19 |
1 files changed, 8 insertions, 11 deletions
@@ -7,7 +7,7 @@ but we do not consider anything stable or usable at this moment. Feel free to play around anyways.** -## Goal / What is imag? +## Mission statement Our (long-term) goal is to @@ -15,9 +15,8 @@ Our (long-term) goal is to > suite of tools to cover all aspects of personal information management. Yes, imag is a rather ambitious project as it tries to reimplement functionality -for several "personal information management aspects". It is a hobby project, -keep that in mind. We try to use standards like vcard, icalendar and others -wherever possible. +for several "personal information management aspects". +We try to use standards like vcard, icalendar and others wherever possible. Have a look at [the documentation](./doc/) for some more words on this. @@ -27,18 +26,16 @@ Have a look at [the documentation](./doc/) for some more words on this. Here is how to try `imag` out. `imag` is a _suite/collection_ of tools (like git, for example) and you can -build them individually. -All subdirectories prefixed with "`libimag"` are libraries. -All subdirectories prefixed with `"imag-"` are binaries and compiling them will -give you a commandline application. +build each "module" individually. ### Building -We use `cargo` for building all crates in this repository. -Make sure to use a recent `cargo`, at least one with workspace support. Building all crates works with `cargo build --all`, building individual crates -by specifying the `--manifest-path` flag to cargo. +by specifying the `--manifest-path` flag to cargo. The crates in ./bin are the +actual commandline tools, ./bin/core contains a core set of imag commands +("plumbing" in git-speak) and ./bin/domain contains domain-specific imag +commands, for example a todo tool or a bookmark tool. ### Running |