summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-05-03 17:49:18 +0200
committerGitHub <noreply@github.com>2017-05-03 17:49:18 +0200
commit1da56c6d9df689150c94631bbb5147c36070b75c (patch)
tree3d133058a70a742d55a47cbb1b33995549852c92
parent878162f263b8d90dccbea8b1b82e96e005e04860 (diff)
parent525491e21fe937768db3d2f6bee44ec4b66704bd (diff)
downloadimag-1da56c6d9df689150c94631bbb5147c36070b75c.tar.gz
imag-1da56c6d9df689150c94631bbb5147c36070b75c.tar.xz
-rw-r--r--.imag-documentation/Cargo.toml2
-rw-r--r--CONTRIBUTING.md25
-rw-r--r--README.md18
-rw-r--r--bin/Cargo.toml2
-rw-r--r--doc/src/00000.md2
-rw-r--r--doc/src/02000-store.md2
-rw-r--r--imag-link/Cargo.toml2
-rw-r--r--imag-link/tests/link-test.sh4
-rw-r--r--imag-notes/Cargo.toml2
-rw-r--r--imag-ref/Cargo.toml2
-rw-r--r--imag-store/Cargo.toml2
-rw-r--r--imag-store/tests/001-create_test.sh10
-rw-r--r--imag-store/tests/002-retrieve_test.sh2
-rw-r--r--imag-tag/Cargo.toml2
-rw-r--r--imag-view/Cargo.toml2
-rw-r--r--libimagentryedit/Cargo.toml2
-rw-r--r--libimagentryfilter/Cargo.toml2
-rw-r--r--libimagentrylink/Cargo.toml2
-rw-r--r--libimagentrylist/Cargo.toml2
-rw-r--r--libimagentrymarkdown/Cargo.toml2
-rw-r--r--libimagentrytag/Cargo.toml2
-rw-r--r--libimagentryview/Cargo.toml2
-rw-r--r--libimagerror/Cargo.toml2
-rw-r--r--libimaginteraction/Cargo.toml2
-rw-r--r--libimagnotes/Cargo.toml2
-rw-r--r--libimagref/Cargo.toml2
-rw-r--r--libimagrt/Cargo.toml2
-rw-r--r--libimagstore/Cargo.toml2
-rw-r--r--libimagstorestdhook/Cargo.toml2
-rw-r--r--libimagtimeui/Cargo.toml2
-rw-r--r--libimagutil/Cargo.toml2
31 files changed, 56 insertions, 55 deletions
diff --git a/.imag-documentation/Cargo.toml b/.imag-documentation/Cargo.toml
index 82e7727c..454ce38e 100644
--- a/.imag-documentation/Cargo.toml
+++ b/.imag-documentation/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-documentation"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Documentation crate of the imag distribution. Does not contain functionality"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f192837b..3f4615d9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,18 +1,18 @@
# 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
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)
by contributing to imag.
## Without Github
-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/)
+If you do not want to use github for your contribution, this is completely okay.
+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
`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
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
-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.
@@ -42,12 +42,13 @@ file issues about them or even better: Write a pull request to fix them!
## Prerequisites
* 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
-file](http://git.imag-pim.org/imag/tree/default.nix),
+Dependencies are listed in the
+[default.nix file](http://git.imag-pim.org/imag/tree/default.nix),
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
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!
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
possible, avoid noise in the codebase, ... you get it.
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
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
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
OR it is a utility library for creating new kinds of functionality within the
imag core.
diff --git a/README.md b/README.md
index 8165f36c..1b42d3f2 100644
--- a/README.md
+++ b/README.md
@@ -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_
and _queryable_ in an uniform way.
-imag consists of _modules_ (e.g. `imag-notes`, `imag-diary`), where each module
-covers one PIM aspect.
+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](https://taskwarrior.org/)
-but `imag-calendar` with [icalendar](https://en.wikipedia.org/wiki/ICalendar)
-files.
+So you can use `imag-todo` with [taskwarrior](https://taskwarrior.org/),
+`imag-mail` with Maildirs and `imag-calendar` with
+[icalendar](https://en.wikipedia.org/wiki/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.
+`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.
@@ -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.
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 these blog posts
diff --git a/bin/Cargo.toml b/bin/Cargo.toml
index 8514a7fc..11895b5f 100644
--- a/bin/Cargo.toml
+++ b/bin/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag command"
diff --git a/doc/src/00000.md b/doc/src/00000.md
index fe83aaa4..94e45894 100644
--- a/doc/src/00000.md
+++ b/doc/src/00000.md
@@ -1,6 +1,6 @@
---
title: imag User Documentation
-version: 0.2.0
+version: 0.3.0
date: July 2016
listings: true
codeBlockCaptions: true
diff --git a/doc/src/02000-store.md b/doc/src/02000-store.md
index 965cd24e..eb4fa860 100644
--- a/doc/src/02000-store.md
+++ b/doc/src/02000-store.md
@@ -72,7 +72,7 @@ An example for a file in the store follows.
---
[imag]
links = ["/home/user/more_kittens.mpeg"]
-version = "0.2.0"
+version = "0.3.0"
[note]
name = "foo"
diff --git a/imag-link/Cargo.toml b/imag-link/Cargo.toml
index c40a7d3c..b4266339 100644
--- a/imag-link/Cargo.toml
+++ b/imag-link/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-link"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-link command"
diff --git a/imag-link/tests/link-test.sh b/imag-link/tests/link-test.sh
index 1f422f96..34b74aea 100644
--- a/imag-link/tests/link-test.sh
+++ b/imag-link/tests/link-test.sh
@@ -8,7 +8,7 @@ default_entry() {
---
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
---
EOS
@@ -19,7 +19,7 @@ entry_linked_to() {
---
[imag]
links = [$1]
-version = "0.2.0"
+version = "0.3.0"
---
EOS
diff --git a/imag-notes/Cargo.toml b/imag-notes/Cargo.toml
index 59f4a802..e84cd3fa 100644
--- a/imag-notes/Cargo.toml
+++ b/imag-notes/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-notes"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-notes command"
diff --git a/imag-ref/Cargo.toml b/imag-ref/Cargo.toml
index 730d966f..fee2ed52 100644
--- a/imag-ref/Cargo.toml
+++ b/imag-ref/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-ref"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-ref command"
diff --git a/imag-store/Cargo.toml b/imag-store/Cargo.toml
index 13e8ebae..6bbd072f 100644
--- a/imag-store/Cargo.toml
+++ b/imag-store/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-store"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-store command"
diff --git a/imag-store/tests/001-create_test.sh b/imag-store/tests/001-create_test.sh
index 3d030b34..c188ea65 100644
--- a/imag-store/tests/001-create_test.sh
+++ b/imag-store/tests/001-create_test.sh
@@ -42,7 +42,7 @@ test_std_header() {
---
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
---
EOS
@@ -63,7 +63,7 @@ test_std_header_plus_custom() {
---
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
[zzz]
zzz = "z"
@@ -90,7 +90,7 @@ bar = "baz"
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
[zzz]
zzz = "z"
@@ -116,7 +116,7 @@ test_std_header_plus_custom_multiheader_same_section() {
---
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
[zzz]
bar = "baz"
@@ -142,7 +142,7 @@ test_std_header_plus_custom_and_content() {
---
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
[zzz]
zzz = "z"
diff --git a/imag-store/tests/002-retrieve_test.sh b/imag-store/tests/002-retrieve_test.sh
index 69529ec3..da88ce12 100644
--- a/imag-store/tests/002-retrieve_test.sh
+++ b/imag-store/tests/002-retrieve_test.sh
@@ -8,7 +8,7 @@ std_header() {
---
[imag]
links = []
-version = "0.2.0"
+version = "0.3.0"
---
EOS
}
diff --git a/imag-tag/Cargo.toml b/imag-tag/Cargo.toml
index 7330e2e1..6a0e0094 100644
--- a/imag-tag/Cargo.toml
+++ b/imag-tag/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-tag"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-tag command"
diff --git a/imag-view/Cargo.toml b/imag-view/Cargo.toml
index c93d8f24..5b7d8120 100644
--- a/imag-view/Cargo.toml
+++ b/imag-view/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "imag-view"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-view command"
diff --git a/libimagentryedit/Cargo.toml b/libimagentryedit/Cargo.toml
index 10f27512..047cc35f 100644
--- a/libimagentryedit/Cargo.toml
+++ b/libimagentryedit/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentryedit"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagentryfilter/Cargo.toml b/libimagentryfilter/Cargo.toml
index 43ab42a7..c3425680 100644
--- a/libimagentryfilter/Cargo.toml
+++ b/libimagentryfilter/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentryfilter"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagentrylink/Cargo.toml b/libimagentrylink/Cargo.toml
index 463149b6..bfe83f1e 100644
--- a/libimagentrylink/Cargo.toml
+++ b/libimagentrylink/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentrylink"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagentrylist/Cargo.toml b/libimagentrylist/Cargo.toml
index 39859a54..3e26495a 100644
--- a/libimagentrylist/Cargo.toml
+++ b/libimagentrylist/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentrylist"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagentrymarkdown/Cargo.toml b/libimagentrymarkdown/Cargo.toml
index 6893a113..e6e58b97 100644
--- a/libimagentrymarkdown/Cargo.toml
+++ b/libimagentrymarkdown/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentrymarkdown"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagentrytag/Cargo.toml b/libimagentrytag/Cargo.toml
index 7d7d0ead..2ff5c790 100644
--- a/libimagentrytag/Cargo.toml
+++ b/libimagentrytag/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentrytag"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagentryview/Cargo.toml b/libimagentryview/Cargo.toml
index f29d6119..fa1dfddb 100644
--- a/libimagentryview/Cargo.toml
+++ b/libimagentryview/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagentryview"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagerror/Cargo.toml b/libimagerror/Cargo.toml
index d1394bd1..960bee7a 100644
--- a/libimagerror/Cargo.toml
+++ b/libimagerror/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagerror"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimaginteraction/Cargo.toml b/libimaginteraction/Cargo.toml
index 95e0dde1..054895b3 100644
--- a/libimaginteraction/Cargo.toml
+++ b/libimaginteraction/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimaginteraction"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagnotes/Cargo.toml b/libimagnotes/Cargo.toml
index 36d8e13e..9c840cb2 100644
--- a/libimagnotes/Cargo.toml
+++ b/libimagnotes/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagnotes"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagref/Cargo.toml b/libimagref/Cargo.toml
index 825f80ee..27028b99 100644
--- a/libimagref/Cargo.toml
+++ b/libimagref/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagref"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagrt/Cargo.toml b/libimagrt/Cargo.toml
index 8655bccd..fdc7ba22 100644
--- a/libimagrt/Cargo.toml
+++ b/libimagrt/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagrt"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagstore/Cargo.toml b/libimagstore/Cargo.toml
index 5e198995..4e5ecbf9 100644
--- a/libimagstore/Cargo.toml
+++ b/libimagstore/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagstore"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagstorestdhook/Cargo.toml b/libimagstorestdhook/Cargo.toml
index 483fa1cf..eec78cb7 100644
--- a/libimagstorestdhook/Cargo.toml
+++ b/libimagstorestdhook/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagstorestdhook"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagtimeui/Cargo.toml b/libimagtimeui/Cargo.toml
index 9c910836..d8491e9b 100644
--- a/libimagtimeui/Cargo.toml
+++ b/libimagtimeui/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagtimeui"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"
diff --git a/libimagutil/Cargo.toml b/libimagutil/Cargo.toml
index 4731a9cf..e9d7a1fd 100644
--- a/libimagutil/Cargo.toml
+++ b/libimagutil/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "libimagutil"
-version = "0.2.0"
+version = "0.3.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Library for the imag core distribution"