GitHub
commit
1da56c6d9d
31 changed files with 56 additions and 55 deletions
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
18
README.md
18
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
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: imag User Documentation
|
||||
version: 0.2.0
|
||||
version: 0.3.0
|
||||
date: July 2016
|
||||
listings: true
|
||||
codeBlockCaptions: true
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ std_header() {
|
|||
---
|
||||
[imag]
|
||||
links = []
|
||||
version = "0.2.0"
|
||||
version = "0.3.0"
|
||||
---
|
||||
EOS
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
Loading…
Reference in a new issue