matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Merge pull request #919 from matthiasbeyer/prepare-0.3.0

Browse source 
Prepare 0.3.0
This commit is contained in:
Matthias Beyer 2017-05-03 17:49:18 +02:00 committed by GitHub
commit 1da56c6d9d
31 changed files with 56 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.imag-documentation/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-documentation" name = "imag-documentation"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Documentation crate of the imag distribution. Does not contain functionality" description = "Documentation crate of the imag distribution. Does not contain functionality"

25
CONTRIBUTING.md
View file

@ -1,18 +1,18 @@
# Contributing to imag # Contributing to imag
So you want to contribute to imag! Thank you, that's awesome of you! So you want to contribute to imag! Thank you, that's awesome!
If you already have something in mind, go ahead with [the prerequisites If you already have something in mind, go ahead with [the prerequisites
section](#prerequisites). If you don't know what you could do, start here. section](#prerequisites). If you don't know what you could do, start here.
All contribors agree to the All contributors agree to the
[developer certificate of origin](#developer-certificate-of-origin) [developer certificate of origin](#developer-certificate-of-origin)
by contributing to imag. by contributing to imag.
## Without Github ## Without Github
If you do not want to use github for your contribution, this is completely okay If you do not want to use github for your contribution, this is completely okay.
with us. Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/) Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/)
via mail, feel also free to submit patches via mail (use `git format-patch` and via mail, feel also free to submit patches via mail (use `git format-patch` and
`git send-email`, always add a cover letter to describe your submission). `git send-email`, always add a cover letter to describe your submission).
@ -25,7 +25,7 @@ Once _I am_ okay with your patchset, I will
submit it as PR in the github repository, so more people can review it and CI submit it as PR in the github repository, so more people can review it and CI
can test it (the mailinglist is not yet used as much as github). I might come can test it (the mailinglist is not yet used as much as github). I might come
back to you if something broke in CI or someone has a suggestion how to improve back to you if something broke in CI or someone has a suggestion how to improve
your PR. I will keep you as author of the commits. your PR. I will keep you as author of the commits.
The following sections describe the way how to contribute with github. The following sections describe the way how to contribute with github.
@ -42,12 +42,13 @@ file issues about them or even better: Write a pull request to fix them!
## Prerequisites ## Prerequisites
* cargo and rust compiler in current version (stable) * cargo and rust compiler in current version (stable)
* Ruby and Bundler if you want to write a Ruby module.
Dependencies are listed in the [default.nix Dependencies are listed in the
file](http://git.imag-pim.org/imag/tree/default.nix), [default.nix file](http://git.imag-pim.org/imag/tree/default.nix),
though you do not have to have `nix` installed to build imag. though you do not have to have `nix` installed to build imag.
`make` (better: `gnu make`) can be helpful to automate the build process. `make` can be helpful to automate the build process.
Note that this software is targeted towards commandline linux users and we do Note that this software is targeted towards commandline linux users and we do
not aim to be portable to Windows or Mac OSX (though I wouldn't mind merging not aim to be portable to Windows or Mac OSX (though I wouldn't mind merging
@ -71,15 +72,15 @@ free to push "Fixup" commits in the review process. We will ask you to clean
your history before merging! your history before merging!
Make sure to prefix your commits with `"doc: "` if you change the document. Do Make sure to prefix your commits with `"doc: "` if you change the document. Do
not change document and code in one commit, always seperate them. not change document and code in one commit, always separate them.
We do not follow some official rust styleguide for our codebase, but we try to We do not follow some official Rust styleguide for our codebase, but we try to
write minimal and readable code. 100 characters per line, as few lines as write minimal and readable code. 100 characters per line, as few lines as
possible, avoid noise in the codebase, ... you get it. possible, avoid noise in the codebase, ... you get it.
Not all of your commits have to be buildable. But your PR has to be. Not all of your commits have to be buildable. But your PR has to be.
## PR guidelines: ## PR guidelines
We'd like to have one PR per module change. This means you _should_ only change We'd like to have one PR per module change. This means you _should_ only change
one imag module in one commit or PR (library plus belonging binary is okay). one imag module in one commit or PR (library plus belonging binary is okay).
@ -101,7 +102,7 @@ If you're writing an application or module for imag, feel free to propose
integrating it into the imag core distribution, if it fulfills the following integrating it into the imag core distribution, if it fulfills the following
requirements: requirements:
1. It is written in Rust 1. It is written in Rust or Ruby
1. It has a commandline interface which is the main interface to the module 1. It has a commandline interface which is the main interface to the module
OR it is a utility library for creating new kinds of functionality within the OR it is a utility library for creating new kinds of functionality within the
imag core. imag core.

18
README.md
View file

@ -25,20 +25,20 @@ 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_ format they use, e.g. vcard) to make the data they manage _linkable_
and _queryable_ in an uniform way. and _queryable_ in an uniform way.
imag consists of _modules_ (e.g. `imag-notes`, `imag-diary`), where each module imag consists of _modules_ (e.g. `imag-notes`, `imag-tag`, `imag-view`), where
covers one PIM aspect. each module covers one PIM aspect.
The initial approach is to use one PIM tool for one module. The initial approach is to use one PIM tool for one module.
So you can use `imag-todo` with [taskwarrior](https://taskwarrior.org/) So you can use `imag-todo` with [taskwarrior](https://taskwarrior.org/),
but `imag-calendar` with [icalendar](https://en.wikipedia.org/wiki/ICalendar) `imag-mail` with Maildirs and `imag-calendar` with
files. [icalendar](https://en.wikipedia.org/wiki/ICalendar) files.
## Building/Running ## Building/Running
Here is how to try `imag` out. Here is how to try `imag` out.
`imag` is a _suite/collection_ of tools and you can build them individually. `imag` is a _suite/collection_ of tools (like git, for example) and you can
All subdirectories prefixed with "`libimag"` are libraries for the respective build them individually.
binaries. All subdirectories prefixed with "`libimag"` are libraries.
All subdirectories prefixed with `"imag-"` are binaries and compiling them will All subdirectories prefixed with `"imag-"` are binaries and compiling them will
give you a commandline application. give you a commandline application.
@ -86,7 +86,7 @@ We also have a [mailinglist](https://imag-pim.org/mailinglist/) where I post
updates and where discussion and questions are encouraged. updates and where discussion and questions are encouraged.
There is a blog series which gets an update once a month on my blog, where There is a blog series which gets an update once a month on my blog, where
[entries are tagged "imag"](https://beyermatthias.de/tags/imag). [entries are tagged "imag"](https://beyermatthias.de/tags/imag/).
I also post non-regular posts about imag things there. I also post non-regular posts about imag things there.
I also post these blog posts I also post these blog posts

2
bin/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag" name = "imag"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag command" description = "Part of the imag core distribution: imag command"

2
doc/src/00000.md
View file

@ -1,6 +1,6 @@
--- ---
title: imag User Documentation title: imag User Documentation
version: 0.2.0 version: 0.3.0
date: July 2016 date: July 2016
listings: true listings: true
codeBlockCaptions: true codeBlockCaptions: true

2
doc/src/02000-store.md
View file

@ -72,7 +72,7 @@ An example for a file in the store follows.
--- ---
[imag] [imag]
links = ["/home/user/more_kittens.mpeg"] links = ["/home/user/more_kittens.mpeg"]
version = "0.2.0" version = "0.3.0"
[note] [note]
name = "foo" name = "foo"

2
imag-link/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-link" name = "imag-link"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-link command" description = "Part of the imag core distribution: imag-link command"

4
imag-link/tests/link-test.sh
View file

@ -8,7 +8,7 @@ default_entry() {
--- ---
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
--- ---
EOS EOS
@ -19,7 +19,7 @@ entry_linked_to() {
--- ---
[imag] [imag]
links = [$1] links = [$1]
version = "0.2.0" version = "0.3.0"
--- ---
EOS EOS

2
imag-notes/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-notes" name = "imag-notes"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-notes command" description = "Part of the imag core distribution: imag-notes command"

2
imag-ref/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-ref" name = "imag-ref"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-ref command" description = "Part of the imag core distribution: imag-ref command"

2
imag-store/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-store" name = "imag-store"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-store command" description = "Part of the imag core distribution: imag-store command"

10
imag-store/tests/001-create_test.sh
View file

@ -42,7 +42,7 @@ test_std_header() {
--- ---
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
--- ---
EOS EOS
@ -63,7 +63,7 @@ test_std_header_plus_custom() {
--- ---
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
[zzz] [zzz]
zzz = "z" zzz = "z"
@ -90,7 +90,7 @@ bar = "baz"
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
[zzz] [zzz]
zzz = "z" zzz = "z"
@ -116,7 +116,7 @@ test_std_header_plus_custom_multiheader_same_section() {
--- ---
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
[zzz] [zzz]
bar = "baz" bar = "baz"
@ -142,7 +142,7 @@ test_std_header_plus_custom_and_content() {
--- ---
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
[zzz] [zzz]
zzz = "z" zzz = "z"

2
imag-store/tests/002-retrieve_test.sh
View file

@ -8,7 +8,7 @@ std_header() {
--- ---
[imag] [imag]
links = [] links = []
version = "0.2.0" version = "0.3.0"
--- ---
EOS EOS
} }

2
imag-tag/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-tag" name = "imag-tag"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-tag command" description = "Part of the imag core distribution: imag-tag command"

2
imag-view/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "imag-view" name = "imag-view"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-view command" description = "Part of the imag core distribution: imag-view command"

2
libimagentryedit/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentryedit" name = "libimagentryedit"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagentryfilter/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentryfilter" name = "libimagentryfilter"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagentrylink/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentrylink" name = "libimagentrylink"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagentrylist/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentrylist" name = "libimagentrylist"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagentrymarkdown/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentrymarkdown" name = "libimagentrymarkdown"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagentrytag/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentrytag" name = "libimagentrytag"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagentryview/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagentryview" name = "libimagentryview"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagerror/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagerror" name = "libimagerror"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimaginteraction/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimaginteraction" name = "libimaginteraction"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagnotes/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagnotes" name = "libimagnotes"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagref/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagref" name = "libimagref"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagrt/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagrt" name = "libimagrt"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagstore/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagstore" name = "libimagstore"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagstorestdhook/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagstorestdhook" name = "libimagstorestdhook"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagtimeui/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagtimeui" name = "libimagtimeui"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"

2
libimagutil/Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "libimagutil" name = "libimagutil"
version = "0.2.0" version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"] authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution" description = "Library for the imag core distribution"