From bebc46fb63428d17f7b8dce67026f6bb3e92eb58 Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Thu, 24 Aug 2017 07:39:20 +0200 Subject: Rename README to README.md Make sure that the Markdown syntax already used in the README file is recognized by repository browsers such as cgit or GitHub. Signed-off-by: Lukas Fleischer --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..a83e8f5 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +calcurse +======== + +Building +-------- + +If you are using a release tarball, the following commands can be used to build +and install 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 +---------------- + +* `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 +------- + +* Lukas Fleischer (Maintainer) +* Frederic Culot (Original Author) + +Contributors +------------ + +* RegEx support: Erik Saule +* Dutch translation: Jeremy Roon, 2007-2010 +* French translation: Frédéric Culot, 2006-2010 +* French translation: Toucouch, 2007 +* French translation: Erik Saule, 2011-2012 +* French translation: Stéphane Aulery, 2012 +* French translation: Baptiste Jonglez, 2012 +* German translation: Michael Schulz, 2006-2010 +* German translation: Chris M., 2006 +* German translation: Benjamin Moeller, 2010 +* German translation: Lukas Fleischer, 2011-2012 +* Portuguese (Brazil) translation: Rafael Ferreira, 2012 +* Russian translation: Aleksey Mechonoshin, 2011-2012 +* Spanish translation: Jose Lopez, 2006-2010 + +Also check the `Thanks` section in the manual for a list of people who have +contributed by reporting bugs, sending fixes, or suggesting improvements. -- cgit v1.2.3