diff options
| author | Lukas Fleischer <lfleischer@calcurse.org> | 2015-04-12 19:14:15 +0200 |
|---|---|---|
| committer | Lukas Fleischer <lfleischer@calcurse.org> | 2015-04-12 19:14:15 +0200 |
| commit | ba81d903b783aaa9c6707d24bb357ab09a8937c5 (patch) | |
| tree | 942dcc8069432ab3a422f229f4adfe04d620f55c /README | |
| parent | f15ac5ce0984c3fac40617b4613f16600d39fe70 (diff) | |
| download | calcurse-ba81d903b783aaa9c6707d24bb357ab09a8937c5.tar.gz calcurse-ba81d903b783aaa9c6707d24bb357ab09a8937c5.zip | |
Update README and AUTHORS
* Add build instructions.
* List the current maintainer first in AUTHORS and README.
* Remove outdated information on the TODO file.
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 23 |
1 files changed, 12 insertions, 11 deletions
@@ -1,21 +1,22 @@ calcurse ======== -Read `INSTALL` for instructions on how to build and install calcurse. +Building +-------- -Check `TODO` for things that still need to be done. +If you are using a release tarball, the following commands can be used to build +and install calcurse: -Browse the file `doc/manual.html` (or its source `doc/manual.txt`) for -detailed descriptions on how to use calcurse. + $ ./configure + $ make + $ make install + +Note that `make install` needs to be run as root. When working on a Git +checkout, you need to run `./autogen.sh` before `./configure`. Package Overview ---------------- -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` @@ -24,8 +25,8 @@ There should be four subdirectories: Authors ------- -* Frederic Culot (Founder) -* Lukas Fleischer (Developer) +* Lukas Fleischer (Maintainer) +* Frederic Culot (Original Author) Contributors ------------ |