Matthias Beyer
ab06263507
This is necessary to be able to re-build a Runtime object with an new set of "commandline arguments". For example if a test wants to test two calls to imag, for example a "add" operation followed by a "remove" operation. These functions are feature-gated therefor and should only be used in tests. |
||
|---|---|---|
| .imag-documentation | ||
| bin | ||
| doc | ||
| lib | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| default.nix | ||
| imagrc.toml | ||
| LICENSE | ||
| README.md | ||
| TODO.md | ||
imag - imag-pim.org
imag is a commandline personal information management suite.
This application is in early development. There are some things that work, but we do not consider anything stable or usable at this moment. Feel free to play around anyways.
Goal / What is imag?
Our (long-term) goal is to
Create a fast, reliable commandline personal information management suite which covers all aspects of personal information management, consists of reusable parts and integrates well with known commandline tools.
Yes, imag is a rather ambitous 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 and icalendar wherever possible.
imag consists of modules (e.g. imag-notes, imag-tag, imag-view), where
each module covers one PIM aspect. Have a look at
the documentation for some more words on this.
Building/Running
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.
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 cding to their directory and calling cargo build.
Running
After you build the module you want to play with, you can simply call the binary
itself with the --help flag, to get some help what the module is capable of.
If you installed the module, you can either call imag-<modulename> (if the
install-directory is in your $PATH), or install the imag binary to call imag <modulename> (also if everything is in your $PATH).
Staying up-to-date
We have a official website for imag, where I post release notes and monthly(ish) updates what's happening in the source tree. There is no RSS feed, though.
We also have a mailinglist where I post updates and where discussion and questions are encouraged.
Documentation
This is a hobby project, so sometimes things are not optimal and might go unrecognized and slip through. Feel free to open issues about things you notice!
Though, we have some documentation in the ./doc subtree which can be compiled to PDF or a website. These docs are not published anywhere and are not even integrated into our CI, so it might be broken (though it's unlikely). Developer documentation is also available online on github.io and on docs.rs, though they might be a bit outdated.
Please contribute!
We are looking for contributors!
Feel free to open issues for asking questions, suggesting features or other things!
Also have a look at the CONTRIBUTING.md file!
Contact
Have a look at our website where you can find some information on how to get in touch and so on.
Feel free to join our new IRC channel at freenode: #imag or our mailinglist.
License
We chose to distribute this software under terms of GNU LGPLv2.1.