Backup repository for imag-pim.org / imag https://imag-pim.org

Find a file

Matthias Beyer df16d0737e Adapt for new API of Habit::next_instance_date() With `cd8f0beae8` the interface of `HabitTemplate::next_instance_date()` changed to return a `Result<Option<_>>` rather than a `Result<_>` because the next_instance_date could be a None if the Habit was closed already. This patch adapts imag-habit for this new interface.		2017-12-22 14:40:01 +01:00
bin	Adapt for new API of Habit::next_instance_date()	2017-12-22 14:40:01 +01:00
doc	Import crate for imag-habit	2017-12-22 14:40:01 +01:00
lib	Merge pull request #1178 from matthiasbeyer/libimaghabit/fix-until	2017-12-22 14:39:41 +01:00
scripts	Add applypatch-msg hook for Signed-off-by line checking	2017-09-01 20:37:53 +02:00
.editorconfig	Remove Makefile/html config, set {md,yaml,nix} indent to 4 spaces	2017-09-08 16:28:21 +02:00
.gitignore	Ignore /out	2016-07-07 23:44:04 +02:00
.travis.yml	Update travis rustc version	2017-12-02 11:02:24 +01:00
Cargo.toml	Import crate for imag-habit	2017-12-22 14:40:01 +01:00
CHANGELOG.md	Add changelog	2017-09-01 14:25:00 +02:00
CONTRIBUTING.md	Move contributing guidelines to documentation	2017-08-11 09:11:12 +00:00
default.nix	Use overlay from Mozilla for build env, to have current rust compiler	2017-08-31 13:07:13 +02:00
imagrc.toml	Add implementation for imag-contact	2017-11-09 11:19:17 +01:00
LICENSE	Add LICENSE file	2015-11-08 17:35:49 +01:00
README.md	Typo	2017-10-31 15:03:30 +01:00
TODO.md	Add TODO file in top-level directory	2017-08-11 09:13:43 +00:00

README.md

imag - imag-pim.org

imag is a commandline personal information management suite.

license

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 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 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 (RSS here).

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.