[Fencommits] fenfire-hs: documentation updates

[Tuukka Hastrup]

Tue Feb 13 14:11:32 EET 2007  Tuukka Hastrup <Tuukka.Hastrup at iki.fi>
  * documentation updates
diff -rN -u old-fenfire-hs/fenfire.cabal new-fenfire-hs/fenfire.cabal
--- old-fenfire-hs/fenfire.cabal	2007-02-13 15:43:13.000000000 +0200
+++ new-fenfire-hs/fenfire.cabal	2007-02-13 15:43:13.000000000 +0200
@@ -3,7 +3,12 @@
 License:        GPL
 License-file:   LICENSE
 Author:         Benja Fallenstein and Tuukka Hastrup
-Synopsis:       Notetaking system
+Maintainer:     fenfire-dev at nongnu.org
+Synopsis:       Graph-based notetaking system
+Description:    Fenfire is a graph-based notetaking system. (We're
+                planning to add a kitchen sink soon.) It is developed 
+                on the channel #fenfire on the Freenode IRC network.
+Category:       User Interfaces
 Stability:      alpha
 Homepage:       http://fenfire.org/
 Build-Depends:  base, HaXml, gtk, mtl, unix, cairo, harp, template-haskell
diff -rN -u old-fenfire-hs/README new-fenfire-hs/README
--- old-fenfire-hs/README	2007-02-13 15:43:13.000000000 +0200
+++ new-fenfire-hs/README	2007-02-13 15:43:13.000000000 +0200
@@ -1,33 +1,35 @@
+===================
+Fenfire version 0.1
+===================
 
-Everything has to do with everything else.
 
-Fenfire is a Free Software project developing a computing environment
-in which you can express these relationships and benefit from them.
-( http://fenfire.org/ )
+Introduction
+============
 
-
-Fenfire-hs is an application designed for notetaking and RDF graph
-browsing. It is developed on the channel #fenfire on the Freenode IRC
-network.
+Fenfire is a graph-based notetaking system. (We're planning to add a
+kitchen sink soon.) It is developed on the channel #fenfire on the
+Freenode IRC network.
 
 
 The source code is available using Darcs.
     darcs get http://antti-juhani.kaijanaho.fi/darcs/fenfire-hs
-    darcs get http://antti-juhani.kaijanaho.fi/darcs/haskell-src-exts
 
-Requirements for compilation:
-fenfire-hs source code
+
+Requirements for compilation
+============================
+
+fenfire source code
   ghc    6.4    (The Glorious Glasgow Haskell Compilation System)
   gtk2hs 0.9.10 (A GUI library for Haskell based on Gtk)
   raptor 1.4.8  (Raptor RDF Parser Toolkit)
   c2hs   0.14.5 (C->Haskell, An Interface Generator for Haskell)
+  harp          (Haskell Regular Patterns, in haskell-src-exts)
   haxml         (Haskell and XML)
-trhsx from our modified haskell-src-exts
   happy         (The Parser Generator for Haskell)
   alex          (A lexical analyser generator for Haskell)
 
-(Packages in Debian: ghc6 libghc6-gtk-dev libraptor1-dev c2hs libghc6-haxml-dev
- happy alex)
+(Packages in Debian: ghc6 libghc6-gtk-dev libraptor1-dev c2hs libghc6-harp-dev 
+ libghc6-haxml-dev happy alex)
 
 
 Running a precompiled binary only requires:
@@ -38,13 +40,39 @@
 (Packages in Debian: libgmp3c2 libgtk2.0-0 libraptor1)
 
 
-Compiling
-=========
+Compiling and running
+=====================
+
+Fenfire-hs is packaged using the Haskell Cabal, which means you can use the 
+following commands to configure, build, and install it to your home directory:
+
+runhaskell Setup.hs configure --user --prefix ~
+runhaskell Setup.hs build
+runhaskell Setup.hs install
+
+After this, you can start the application like this:
+
+~/bin/fenfire
+
+You will see the application launch with a new graph where you can
+start adding your notes using the Edit menu and the included key bindings.
+
+* The current node is highlighted in blue.
 
-In the directory haskell-src-exts, run the following command:
+* To write into the current node, move to the text box at the bottom
+  of the window using Tab or the mouse. After you've finished typing,
+  use Tab or the mouse to get back to the graph box.
 
-    make STAGES='clean "configure -p --prefix=$$HOME --user" build install'
+* Use the Edit menu or the keybindings indicated in the Edit menu to
+  - create new nodes
+  - mark the current node, or connect the current node to the
+    previously marked node(s)
+  - break connections between nodes
 
-In the directory fenfire-hs, run the following command:
+* Use the arrow keys to move between nodes:
+  - Left and Right move to the node directly left or directly right
+    from the current node.
+  - Up and Down scroll through the nodes connected to the current node.
+  - Instead of Left/Right/Up/Down, you can also use j/l/i/comma.
 
-    make TRHSX=$HOME/bin/trhsx
+You cannot currently use the mouse to move around the structure.