aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorLukas Fleischer <calcurse@cryptocrack.de>2012-03-29 23:17:37 +0200
committerLukas Fleischer <calcurse@cryptocrack.de>2012-03-30 10:22:36 +0200
commitf3ccc70e379269a67c7278856af5365bdcc20f7d (patch)
tree51f89008e2227e938b7cf0f1d126d34ba22860af /README
parentc85c3cce558b32c4fb00a339872d4dbe035d3f6c (diff)
downloadcalcurse-f3ccc70e379269a67c7278856af5365bdcc20f7d.tar.gz
calcurse-f3ccc70e379269a67c7278856af5365bdcc20f7d.zip
README: Update with recent changes
Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 11 insertions, 6 deletions
diff --git a/README b/README
index 6c8a40a..72f4611 100644
--- a/README
+++ b/README
@@ -6,20 +6,25 @@ Read `INSTALL` for instructions on how to build and install calcurse.
Check `TODO` for things that still need to be done.
Browse the file `doc/manual.html` (or its source `doc/manual.txt`) for
-narrative descriptions on how to use calcurse.
+detailed descriptions on how to use calcurse.
Package Overview
----------------
-You should be reading this file in a directory called: `calcurse-x.x`, where
-`x.x` is the current version number. There should be two subdirectories : `src`
-and `doc`. Detailed documentation in HTML format can be found in the `doc`
-directory. Calcurse sources can be found in the `src` directory.
+You should be reading this file in a directory called: `calcurse-x.y.z`, where
+`x.y.z` is the current version number.
+
+There should be four subdirectories:
+
+* `src`: contains calcurse sources
+* `test`: contains a test suite and test cases for calcurse
+* `scripts`: contains additional scripts, such as `calcurse-upgrade`
+* `doc`: contains detailed documentation in plain text and HTML
Authors
-------
-* Frederic Culot (Founder, Lead Developer)
+* Frederic Culot (Founder)
* Lukas Fleischer (Developer)
Contributors