Backup repository for imag-pim.org / imag https://imag-pim.org
Find a file
2017-06-18 18:51:58 +02:00
.imag-documentation libimagstorestdhook: Remove 2017-06-06 11:12:36 +02:00
bin Add missing license headers 2017-06-07 20:45:38 +02:00
doc Change backends to do less ser-/deserialization 2017-06-18 12:32:04 +02:00
imag-bookmark Update version strings: 0.2.0 -> 0.3.0 2017-05-30 21:23:33 +02:00
imag-counter Update version strings: 0.2.0 -> 0.3.0 2017-05-30 21:23:33 +02:00
imag-diary Update version strings: 0.2.0 -> 0.3.0 2017-05-30 21:23:33 +02:00
imag-link Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
imag-mail Update version strings: 0.2.0 -> 0.3.0 2017-05-30 21:23:33 +02:00
imag-notes Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
imag-ref Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
imag-store Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
imag-tag Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
imag-todo dependency: toml-query: 0.1.0 -> 0.2.0 2017-06-07 12:29:57 +02:00
imag-view Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagannotation Update version strings: 0.2.0 -> 0.3.0 2017-05-30 21:23:33 +02:00
libimagbookmark Update version strings: 0.2.0 -> 0.3.0 2017-05-30 21:23:33 +02:00
libimagcounter dependency: toml-query: 0.1.0 -> 0.2.0 2017-06-07 12:29:57 +02:00
libimagdiary dependency: toml-query: 0.1.0 -> 0.2.0 2017-06-07 12:29:57 +02:00
libimagentrydatetime Fix header location for datetime values 2017-06-07 17:25:58 +02:00
libimagentryedit Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
libimagentryfilter Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagentrylink Impl Display for StoreLinkConsistencyErrorCustomData 2017-06-06 19:04:53 +02:00
libimagentrylist Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagentrymarkdown Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
libimagentrytag Add is_tag_str(&str) wrapper for is_tag(String) 2017-06-17 12:34:13 +02:00
libimagentryview Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagerror Allow custom data in errors to be displayed 2017-06-06 19:04:53 +02:00
libimaginteraction Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagmail Add missing license headers 2017-06-07 17:40:45 +02:00
libimagnotes Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagref Merge pull request #930 from matthiasbeyer/update-toml 2017-05-03 21:19:06 +02:00
libimagrt Add Runtime::store_backend_to_stdio() function 2017-06-18 13:37:50 +02:00
libimagstore Add tests to test backend replacing 2017-06-18 18:51:58 +02:00
libimagtimeui Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
libimagtodo dependency: toml-query: 0.1.0 -> 0.2.0 2017-06-07 12:29:57 +02:00
libimagutil Add missing license headers 2017-06-07 20:45:38 +02:00
tests test setup: Prepare store directory before starting tests 2016-09-08 14:23:10 +02:00
.editorconfig Add editorconfig configuration file 2016-01-11 19:47:51 +01:00
.gitignore Ignore /out 2016-07-07 23:44:04 +02:00
.travis.yml Bump minimal supported rustc to 1.15 2017-05-03 20:44:52 +02:00
Cargo.toml Merge pull request #941 from matthiasbeyer/libimagentrydate/init 2017-06-07 17:00:52 +02:00
CONTRIBUTING.md Remove libimagstorestdhook entry 2017-06-06 11:12:37 +02:00
default.nix Remove libimagruby 2017-05-02 17:14:48 +02:00
imagrc.toml Remove hook config from example config file 2017-06-06 11:12:37 +02:00
LICENSE Add LICENSE file 2015-11-08 17:35:49 +01:00
Makefile Remove libimagruby 2017-05-02 17:14:48 +02:00
README.md Added Tokei badge for displaying LOC 2017-05-10 13:50:53 +02:00

imag - imag-pim.org

imag is a commandline personal information management suite.

Build Status Issue Stats Issue Stats license Tokei

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.

imag is a PIM helper. We do not actually implement the PIM functionality, but try to interface with existing PIM tools (via their API or via some standard format they use, e.g. vcard) to make the data they manage linkable and queryable in an uniform way.

imag consists of modules (e.g. imag-notes, imag-tag, imag-view), where each module covers one PIM aspect. The initial approach is to use one PIM tool for one module. So you can use imag-todo with taskwarrior, imag-mail with Maildirs and imag-calendar with icalendar files.

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 make to automate the build process. Make sure to not include some -j 8 arguments, this will not work as you might think!

There are several targets for each of the sub-crates in the Makefile:

Target Multi Purpose Example
all Build everything, debug mode make all
bin Build all binaries, debug mode make bin
lib Build all libraries, debug mode make lib
lib-test Test all libraries make lib-test
imag-bin Build only the imag binary, debug mode make imag-bin
clean Remove build artifacts make clean
update Run cargo update make update
check-outdated Run cargo outdated make check-outdated
check * Run cargo check make check
install * Build everything, release mode, install make install
release * Build everything, release mode make release

The Multi targets are callable for each sub-crate. For example you can call make imag-store-check to run cargo check on the imag-store crate.

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. There is no RSS feed, though.

We also have a mailinglist where I post updates and where discussion and questions are encouraged.

There is a blog series which gets an update once a month on my blog, where entries are tagged "imag". I also post non-regular posts about imag things there.

I also post these blog posts on reddit and submit them to this-week-in-rust.

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!

There is always a number of complexity/easy tagged issues available in the issue tracker you can start with and we are open to questions!

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.