Backup repository for imag-pim.org / imag https://imag-pim.org
Find a file
2017-01-22 18:44:47 +01:00
.imag-documentation Remove stuff for the focus-shift 2017-01-21 13:05:50 +01:00
bin Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
doc Increment header levels in the README.md I missed in the first run 2016-10-13 12:07:54 +02:00
imag-link Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
imag-notes Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
imag-ref Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
imag-store Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
imag-tag Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
imag-view Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagentryedit Fix: Cargo.toml does not know "website", but "homepage" 2016-10-20 14:14:18 +02:00
libimagentryfilter Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagentrylink Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagentrylist Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagentrymarkdown Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagentrytag Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagentryview Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagerror Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimaginteraction Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagnotes Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagref Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagrt Make configuration module public 2017-01-22 15:44:21 +01:00
libimagruby Add more tests 2017-01-22 18:44:47 +01:00
libimagstore Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagstorestdhook Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagtimeui Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01:00
libimagutil Move [profile.dev] codegen-units = 2 to top-level Cargo.toml 2017-01-19 20:08:51 +01: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 Change lowest rust version in .travis.yml to 1.13.0 from 1.11.0 2017-01-19 20:47:18 +01:00
Cargo.toml Initialize imag-ruby 2017-01-21 13:56:05 +01:00
CONTRIBUTING.md Some general updates 2016-08-24 17:11:16 +02:00
default.nix Fix default.nix syntax 2016-10-15 15:46:27 +02:00
imagrc.toml Merge pull request #775 from matthiasbeyer/libimaginteraction/readline 2016-10-11 18:22:41 +02:00
LICENSE Add LICENSE file 2015-11-08 17:35:49 +01:00
Makefile Disable ruby testing in lib-test as travis-ci does not have ruby 2.3.0 2017-01-21 13:56:05 +01:00
README.md Fix wording 2016-10-27 16:40:29 +02:00

imag - imag-pim.org

imag is a commandline personal information management suite.

Build Status Issue Stats Issue Stats 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.

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-diary), 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 but imag-calendar with icalendar files.

Building/Running

Here is how to try imag out.

imag is a suite/collection of tools and you can build them individually. All subdirectories prefixed with "libimag" are libraries for the respective binaries. 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 (as cargo is not (yet?) able to build several applications at once). Make sure to not include some -j 8 arguments, as cargo parallelizes the build process on its own. If you parallelize it with make, you end up with a really high load on your system.

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
check * Run cargo check make check
clean * Remove build artifacts make clean
install * Build everything, release mode, install make install
release * Build everything, release mode make release
update * Run cargo update make update

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

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 a update every other week 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.

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.