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

Find a file

Matthias Beyer 6abdd88182 Fix wording		2016-10-04 13:49:57 +02:00
.imag-documentation	.imag-documentation: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
bin	bin: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
doc	Merge pull request #601 from matthiasbeyer/doc-updates	2016-08-02 13:01:40 +02:00
imag-bookmark	imag-bookmark: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-counter	imag-counter: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-diary	imag-diary: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-link	imag-link: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-notes	imag-notes: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-ref	imag-ref: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-store	imag-store: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-tag	imag-tag: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-todo	imag-todo: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
imag-view	imag-view: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagbookmark	libimagbookmark: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagcounter	libimagcounter: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagdiary	libimagdiary: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentryedit	libimagentryedit: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentryfilter	libimagentryfilter: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentrylink	libimagentrylink: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentrylist	libimagentrylist: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentrymarkdown	libimagentrymarkdown: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentrytag	libimagentrytag: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagentryview	libimagentryview: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagerror	libimagerror: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimaginteraction	libimaginteraction: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagnotes	libimagnotes: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagref	libimagref: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagrt	libimagrt: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagstore	libimagstore: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagstorestdhook	libimagstorestdhook: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagtimeui	libimagtimeui: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagtodo	libimagtodo: Add copyright notice to all files	2016-10-01 17:35:06 +02:00
libimagutil	libimagutil: Add copyright notice to all files	2016-10-01 17:35:06 +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	Merge pull request #734 from matthiasbeyer/test-via-makefile	2016-09-20 10:20:59 +02:00
CONTRIBUTING.md	Some general updates	2016-08-24 17:11:16 +02:00
default.nix	Add dependencies for imag: openssl, zlib, cmake	2016-09-07 17:11:23 +02:00
imagrc.toml	Add settings for enable/disable hook	2016-09-20 09:35:02 +02:00
LICENSE	Add LICENSE file	2015-11-08 17:35:49 +01:00
Makefile	Add `sort` for always same build order	2016-09-24 11:01:00 +02:00
README.md	Fix wording	2016-10-04 13:49:57 +02:00

README.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.

license

What is this / Goal and Functionality

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.

We try to implement as many aspects of personal information management (PIM), but re-use existing commandline tools. We do this by tracking/referring to the data the tools create. A user can now link pieces of data (from different tools), tag this data and query/search this data using imag. So imag is more like a data-mining helper than an actual PIM tool, but we implement some of the PIM aspects directly in imag. Parts of PIM (we call them "modules") that are already implemented and basically working:

todo (via taskwarrior, we track the tasks one creates in taskwarrior)
diary
notes
bookmarks
counter (just an example, nothing that usable)

Helper modules that come with imag but are not "PIM aspects":

linking entries
viewing entries
tagging entries
creating misc entries
creating entries that refer to files/directories

Building/Running

Here goes how to try imag out.

imag is a suite 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

By now, there are several targets in the Makefile, fulfilling following roles:

all is the default and builds every crate in debug mode. To build a single module, call make <module>, for example make imag-store.
release, as the name implies, builds every module in release mode. E.G.: make imag-store-release to build "imag-store" in release mode.
install will install all commandline modules to the default installation root (see man cargo-install). To install a single module, run make <module>-install, E.G.: make imag-store-install
bin/lib are separate targets for either building all binaries or libraries.
lib-test runs cargo test for all libraries. For testing a single library, E.G.: make test-libimagstore.
clean will run cargo clean in every crate. For cleaning a single crate, use make imag-store-clean for example.
to build only the imag binary, use the target imag-bin (imag-bin-release for release build, imag-bin-clean for cargo cleaning).

Running

To test out a single module, simply using cargo run -- <options> in the respective directory will do the trick. But you can also make <module> and call the binary on the commandline. For using it "normally", install the binaries as described above, as well as the imag-binary:

$> make install

The installation root of the binaries may not yet be in your $PATH. To see where this installation root is check out man cargo-install. To change the $PATH in bash:

$> PATH=$PATH:~/.cargo/bin
$> imag --help

To test, simply add --help to one of the above commands:

$> imag counter --help

Documentation

For detailed information, please read the documentation. You can either read the Markdown files or compile it to HTML/PDF using pandoc. Developer documentation is also available online on github.io.

Please note that the documentation is work in progress as well and may be 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.

This decision was made to ensure everyone can write applications which use the imag core functionality which is distributed with the imag source distribution.