summaryrefslogtreecommitdiff
path: root/office/zim/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/zim/README')
-rw-r--r--office/zim/README38
1 files changed, 24 insertions, 14 deletions
diff --git a/office/zim/README b/office/zim/README
index 5480b8d446..1d303ff71e 100644
--- a/office/zim/README
+++ b/office/zim/README
@@ -1,15 +1,25 @@
-Zim is a graphical text editor used to maintain a collection of wiki pages.
-Each page can contain links to other pages, simple formatting and images.
-Pages are stored in a folder structure, like in an outliner, and can have
-attachments. Creating a new page is as easy as linking to a nonexistent
-page. All data is stored in plain text files with wiki formatting. Various
-plugins provide additional functionality, like a task list manager, an
-equation editor, a tray icon, and support for version control.
+Zim aims to bring the concept of a wiki to your desktop. Every page is
+saved as a text file with wiki markup. Pages can contain links to other
+pages, and are saved automatically. Creating a new page is as easy as
+linking to a non-existing page. This tool is intended to keep track of
+TODO lists or to serve as a personal scratch book. But it will also
+serve you when writing longer and more complicated documents.
-Zim can be used to:
- * Keep an archive of notes
- * Keep a daily or weekly journal
- * Take notes during meetings or lectures
- * Organize task lists
- * Draft blog entries and emails
- * Do brainstorming
+A "desktop wiki" means that we try to capture the idea of a wiki, not
+as a webpage but as a collection of files on your local file system
+that can be edited with a GUI application. The main focus is a kind
+of personal wiki that serves for all kind of notes: todo-lists,
+addresses, brainstorm ideas etc.
+
+But we want to go further then just a wiki filled with random content.
+It should also be possible to use you random notes as the basis for
+more structured data: articles, presentations etc. Zim will not include
+tools to layout a presentation or something like that, you should use
+your office suite of choice for that, but it should be a tool that can
+deliver all the content for a presentation in a form that only needs a
+template and some layout before usage. Therefore certain features
+normally not found in wikis will be added.
+
+NOTE: Zim can be expanded with plugins. From 'preferences' go to
+'plugins' and anything marked 'failed' can be installed either
+from SBo or pip. These aren't dependencies; Zim runs without them.