matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Rewrite README to contain less boilerplate text

Browse source 
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
This commit is contained in:
Matthias Beyer 2019-12-06 20:28:27 +01:00
parent 17d2e55bfa
commit e2d006d563
1 changed files with 8 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -7,7 +7,7 @@ but we do not consider anything stable or usable at this moment. Feel free to
play around anyways.** play around anyways.**
## Goal / What is imag? ## Mission statement
Our (long-term) goal is to 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. > suite of tools to cover all aspects of personal information management.
Yes, imag is a rather ambitious project as it tries to reimplement functionality Yes, imag is a rather ambitious project as it tries to reimplement functionality
for several "personal information management aspects". It is a hobby project, for several "personal information management aspects".
keep that in mind. We try to use standards like vcard, icalendar and others We try to use standards like vcard, icalendar and others wherever possible.
wherever possible.
Have a look at [the documentation](./doc/) for some more words on this. 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. Here is how to try `imag` out.
`imag` is a _suite/collection_ of tools (like git, for example) and you can `imag` is a _suite/collection_ of tools (like git, for example) and you can
build them individually. build each "module" individually.
All subdirectories prefixed with "`libimag"` are libraries.
All subdirectories prefixed with `"imag-"` are binaries and compiling them will
give you a commandline application.
### Building ### 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 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 ### Running