diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2016-07-08 17:51:18 +0200 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2016-07-08 20:43:06 +0200 |
commit | 28a9c5ffc9ed6880cd4b39ab89ffc02104723d7e (patch) | |
tree | 96a9908834d6664c5704cdfb1a4db2fab274dc65 /doc | |
parent | 12cb61cd8b283e391435a882a8a112dbe08e0015 (diff) |
doc: Rewrote intro
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/01000-intro.md | 28 |
1 files changed, 8 insertions, 20 deletions
diff --git a/doc/src/01000-intro.md b/doc/src/01000-intro.md index eb504776..37653f6b 100644 --- a/doc/src/01000-intro.md +++ b/doc/src/01000-intro.md @@ -1,25 +1,10 @@ # Introduction {#sec:introduction} -In the following work, we define the architecture, internal interfaces and the -implementation of `imag` (called "the program" in the following chapters). - -The program is intended to be an _Personal Information Management Suite_ -(PIM-Suite), featuring all components such a suite should have, including -contact management, calendar, todo-list functionality, etc. -The program is intended to be used by so-called "power-users", therefor it is a -commandline application which offers a polished interface to the user and is not -bound to an editor, e-mail reader, RSS reader, etc. The program uses standards -as icalendar, vcard, RSS/Atom, Markdown, etc. - -The development of this program may adapt other programs. For example, the -todo-module may be implemented with the "taskwarrior" application, if possible, -so we try to re-use functionality which is implemented elsewhere and where other -people put a lot of effort into. We clearly do not want to duplicate -functionality, work and effort or implementations. - -"imag" is a single-user, one-shot program. It is not intended to be used by -multiple users with the same storage at the same time. -This may change in the future. +This document aims to be the user documentation for imag, the personal +information management suite for the commandline. + +If you have any objections, suggestions for improvements, bugs, etc, please file +them in the github repository you got this documentation from. ## The Problem {#sec:intro:problem} @@ -57,3 +42,6 @@ to implement and adapt "imag" functionality. An external program may use a library of the "imag" distribution to store content in the store of "imag" and make it visible to "imag" this way. +This is a technical detail a user does not necessarily need to know, but as imag +is intended for power-users anyways, we could say it fits here. + |