* doc/TheFuture:

* README:
Update for 0.3 release


git-svn-id: http://labyrinth.googlecode.com/svn/trunk@134 8f060a39-251c-0410-b1f3-431655927647

1 files changed, 77 insertions, 25 deletions

diff --git a/README b/README
index 13b969a..b190a1e 100644
--- a/README
+++ b/README
@@ -4,30 +4,51 @@ Labyrinth
 License
 -------
 
-This software is released under the GNU GPL v2 (or later) license.  All source files are included in this, unless explicitely stated in the source file itself.  For copyright owners, please refer to the source files individually.
+This software is released under the GNU GPL v2 (or later) license.  All source
+files are included in this, unless explicitly stated in the source file itself.
+  For copyright owners, please refer to the source files individually.
 
-The "labyrinth" icon (data/labyrinth.svg and data/labyrinth-*.png) is copyright Josef Vybíral and is released under the GNU GPL v2 license.
+The "labyrinth" icon (data/labyrinth.svg and data/labyrinth-*.png) is copyright
+Josef Vybíral and is released under the GNU GPL v2 license.
 
-Please refer to the "COPYING" file for a complete copy of the GNU GPL v2 license.
+Please refer to the "COPYING" file for a complete copy of the GNU GPL v2
+license.
 
-All documentation (This file, anything in the docs directory) released with this package is released as public domain.  The documentation, you can do with as you please.
+All documentation (This file, anything in the docs directory) released with
+this package is released as public domain.  The documentation, you can do with
+as you please.
 
 What is it?
 -----------
 
-Labyrinth is a mind-mapping tool, written in Python using Gtk and Cairo to do the drawing.  It was written by me (DonScorgie@Blueyonder.co.uk).
+Labyrinth is a lightweight mind-mapping tool, written in Python using Gtk and
+Cairo to do the drawing.  It is intended to be as light and intuitive as
+possible, but still provide a wide range of powerful features.
 
-A mind-map is a diagram used to represent words, ideas, tasks or other items linked to and arranged radially around a central key word or idea. It is used to generate, visualise, structure and classify ideas, and as an aid in study, organisation, problem solving, and decision making. (From wikipedia)
+A mind-map is a diagram used to represent words, ideas, tasks or other items
+linked to and arranged radially around a central key word or idea. It is used
+to generate, visualise, structure and classify ideas, and as an aid in study,
+organisation, problem solving, and decision making. (From wikipedia)
 
 Current Release
 ---------------
 
-This is v0.2.  It is not even pre-alpha yet.  It doesn't have much of an interface.  It is liable to kill kittens if used.  It has been tested by me, and works under my configuration (Ubuntu Dapper and now Ubuntu Edgy).  I'm not guaranteeing anything about anyone else's computer or work or anything.  You may also notice it's pretty ugly and probably highly inefficient.  I'm working on it.
+This is v0.3.  Note that maps created with this release may be incompatible
+with future releases.  We will try and minimise this as much as possible, but
+be warned that it may happen.
+
+Currently, Labyrinth provides 3 different types of thoughts, or nodes - Text,
+Image and Drawing.  Text is the basic standard text node.  Images allow you to
+insert and scale any supported image file (png, jpeg, svg).  Drawings are for
+those times when you want to illustrate something, but don't want to fire up
+a separate drawing program.  It allows you to quickly and easily sketch very
+simple line diagrams.
 
 Requirements
 ------------
 
-I don't really know what the exact requirements are.  In the configure script, the following are checked:
+I don't really know what the exact requirements are.  In the configure script,
+the following are checked:
 Python              == 2.4
 gtk+                >= 2.8
 pygtk-2.0           >= 2.8
@@ -36,7 +57,10 @@ gnome-python-2.0    >= 2.12
 gnome-desktop-2.0   >= 2.14
 pycairo             >= 1.0
 
-which probably means (to compile) you need the -dev versions of all these (except Python).
+which probably means (to compile) you need the -dev versions of all these
+(except Python).  Note that although these are checked, it may work with
+previous versions.  If it does, please let us know and the configure script
+can be adapted accordingly.
 
 How to use it
 -------------
@@ -52,41 +76,69 @@ make install
 and run with:
 labyrinth
 
-This will open a browser window, showing you all the maps currently available and allow you to modify / delete them and create new maps.  The title is (currently) the primary thought text(truncated to 27 characters long).  This is usually the first thought created in a new map.
+This will open a browser window, showing you all the maps currently available
+and allow you to modify / delete them and create new maps.  The title is
+(currently) the primary thought text(truncated to 27 characters long).  This is
+usually the first thought created in a new map.
 
-In a new map, single click somewhere to create a new "thought".  This is your root.  Add your main thought to this.  Click somewhere else will create a new thought, linked to the first.  Clicking on the root allows you to drag it around.  Double click to edit it.  Clicking on another thought will make that the root, with future thoughts linking back to it.  Changing to Move mode allows thoughts to be dragged around and delete (with the delete key).
+In a new map, single click somewhere to create a new "thought".  This is your
+root.  Add your main thought to this.  Click somewhere else will create a new
+thought, linked to the first.  To move thoughts around, single-click and drag.
+To edit a current thought, double click on it (text thoughts only).
 
-Links between thoughts can be created, strengthened and weakened.  To create a new link, in edit mode, click and drag from the "parent" thought to the "child" thought.  Doing this with a link already in place will strengthen the link by 1 and dragging from child to parent will weaken the link by 1.  If the link goes to 0 strength (it starts at 2), the link is deleted.
+Drawing and Image thoughts can be resized using their corners / sides.
 
-That's basically all there is too it.  Oh, you can move the (text) cursor around within a thought and thoughts can span > 1 line if you like.
+Links between thoughts can be created, strengthened and weakened.  To create a
+new link, in edit mode, click and drag from the "parent" thought to the "child"
+thought while holding down the ctrl key.  Doing this with a link already in
+place will strengthen the link by 1 and dragging from child to parent will
+weaken the link by 1.  If the link goes to 0 strength (it starts at 2),
+the link is deleted.  Links can also be created / deleted by selecting both
+thoughts (hold down the shift key to select > 1 thought) and choosing
+"Edit->(Un)Link Thoughts" from the menu (shortcut: Ctrl-L).
 
-Loading and saving of maps is in the tomboy style - they are automatically saved, you shouldn't have to worry about them.  For reference anyway, the maps are saved in ~/.gnome2/labyrinth/<longstring>.map
+Loading and saving of maps is in the tomboy style - they are automatically
+saved, you shouldn't have to worry about them.  For reference anyway, the maps
+are saved in ~/.gnome2/labyrinth/<longstring>.map
 
 a11y, themes and i18n
 ---------------------
 
-All these are currently missing.  The background is always white.  The font is always the same.  The interface is always in English.
+All these are currently missing.  The background is always white.  The font is
+always the same.  The interface is always in English.
 
-This should change soon, with bits 'n pieces marked for translation and different font sizes allowed.  The colours should be changable and (where possible) follow the current theme.
+This should change soon, with bits 'n pieces marked for translation and
+different font sizes allowed.  The colours should be changable and (where
+possible) follow the current theme.
 
-I'm also looking at ways of making Labyrinth accessible.  Don't know exactly how to do this yet and my previous attempts at adding simple a11y stuff failed miserably.
+I'm also looking at ways of making Labyrinth accessible.  Don't know exactly
+how to do this yet and my previous attempts at adding simple a11y stuff failed
+miserably.
 
 
 Future Plans
 ------------
 
-Really don't know.  Haven't thought about anything more than this stage.  I don't even know whats going to be in the next release - it'll be a magical mystery tour.
-
-On the other hand, if you really want to know, check TheFuture in the docs directory.
+In doc/TheFuture, there are a list of goals for a 1.0 release and for the next
+release.  Releases are feature-based at this stage.  Once all the required
+features are in place, a release is made.
 
-It is also very possible that future work may break the map format, so be warned that this might happen.
+However a release may also be made without all the changes if it is deemed
+that this is in the best interest.
 
 Getting the Latest Development Code
 -----------------------------------
 
-It's sitting in a SVN repo on my computer.  email me if you want a copy.  Or pester me a little and I might put it in a  public place.
+Development happens in Google SVN.  Instructions for grabbing the latest source
+can be found at http://code.google.com/p/labyrinth/source
 
-Helping Out
------------
+Helping Out and Questions
+-------------------------
+
+If you have any questions about Labyrinth or just want to be part of our gang,
+the mailing list address is labyrinth-devel@googlegroups.com
 
-Please.  Email me and let me know what you want to work on.  Send patches.
+If you want to help out with developing labyrinth, please let us know on the
+mailing list.  We aren't just looking for coders.  We're looking for packagers,
+artists, doc writers, interface designers, web developers, and just about
+anyone else.