Matthias Beyer
82e61db4f7
Therefor we need to have at least clap 2.16.1. We bake this into libimagrt::runtime::Runtime, so all binary crates should automatically have it. |
||
|---|---|---|
| .imag-documentation | ||
| bin | ||
| doc | ||
| imag-bookmark | ||
| imag-counter | ||
| imag-diary | ||
| imag-link | ||
| imag-notes | ||
| imag-ref | ||
| imag-store | ||
| imag-tag | ||
| imag-todo | ||
| imag-view | ||
| libimagbookmark | ||
| libimagcounter | ||
| libimagdiary | ||
| libimagentryedit | ||
| libimagentryfilter | ||
| libimagentrylink | ||
| libimagentrylist | ||
| libimagentrymarkdown | ||
| libimagentrytag | ||
| libimagentryview | ||
| libimagerror | ||
| libimaginteraction | ||
| libimagmail | ||
| libimagnotes | ||
| libimagref | ||
| libimagrt | ||
| libimagstore | ||
| libimagstorestdhook | ||
| libimagtimeui | ||
| libimagtodo | ||
| libimagutil | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| default.nix | ||
| imagrc.toml | ||
| LICENSE | ||
| Makefile | ||
| 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.
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:
allis the default and builds every crate in debug mode. To build a single module, callmake <module>, for examplemake imag-store.release, as the name implies, builds every module in release mode. E.G.:make imag-store-releaseto build "imag-store" in release mode.installwill install all commandline modules to the default installation root (seeman cargo-install). To install a single module, runmake <module>-install, E.G.:make imag-store-installbin/libare separate targets for either building all binaries or libraries.lib-testrunscargo testfor all libraries. For testing a single library, E.G.:make test-libimagstore.cleanwill runcargo cleanin every crate. For cleaning a single crate, usemake imag-store-cleanfor example.- to build only the
imagbinary, use the targetimag-bin(imag-bin-releasefor release build,imag-bin-cleanforcargo 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
Staying up-to-date
Despite we have a official site for imag, I do not push updates to this site, yet. Anyways, I post a blog articles about what happened in the last two weeks every other week.
You can find them on my personal blog, tagged "imag"
I also post these blog posts on reddit and submit them to this-week-in-rust.
From time to time I publish an article about imag which does not focus on some things that are happening, but rather about something more general.
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.