From 9f8622905cb4b8e15b491b6c3d3b81a1260f983f Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Sat, 25 Aug 2018 10:47:44 +0200 Subject: Update README.md * Add more details on the project directory structure. * Add information on contributions and donations. * Move contributors to the manual but keep a reference. Signed-off-by: Lukas Fleischer --- README.md | 52 +++++++++++++++++++++++++--------------------------- doc/manual.txt | 16 +++++++++++----- 2 files changed, 36 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index d8ed623..b9941c3 100644 --- a/README.md +++ b/README.md @@ -27,34 +27,32 @@ 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 +* `build-aux`: auxiliary files for the build process +* `contrib`: useful tools such as hooks or the CalDAV synchronization script +* `doc`: detailed documentation in plain text and HTML +* `po`: translations and i18n-related files +* `scripts`: additional official scripts, such as `calcurse-upgrade` +* `src`: the actual calcurse source files +* `test`: test suite and test cases for calcurse 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. +calcurse was originally authored by Frederic Culot and is currently maintained +by Lukas Fleischer. + +Of course, there are numerous other contributors. Check the Git commit log and +the `Thanks` section in the manual for a list of people who have contributed by +reporting bugs, sending fixes, or suggesting improvements. + +Contributing and Donations +-------------------------- + +Patches, bug reports and other requests are always welcome! You can submit them +to one of our mailing lists (check the [patch submission +guidelines](doc/submitting-patches.txt) for details) or via GitHub. + +We are also extremely grateful for donations which help us continue developing +calcurse as open source software and are used to cover recurring costs, such as +for our servers. You can use https://calcurse.org/donate/ for a one-time +payment. If you prefer another form of donation, do not hesitate to contact us! diff --git a/doc/manual.txt b/doc/manual.txt index c4ee431..76683fa 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -1495,7 +1495,7 @@ Thanks ------ Its time now to thank other people without whom this program would not exist! -So here is a list of contributing persons I would like to thank : +So here is a list of contributing persons I would like to thank: * Alex for its patches, help and advices with `C` programming @@ -1519,8 +1519,8 @@ So here is a list of contributing persons I would like to thank : * Jeremy Roon for the Dutch translation -* Frédéric Culot, Toucouch, Erik Saule, Stéphane Aulery - and Baptiste Jonglez for the French translation +* Frédéric Culot, Toucouch, Erik Saule, Stéphane Aulery and Baptiste Jonglez + for the French translation * Michael Schulz, Chris M., Benjamin Moeller and Lukas Fleischer for the German translation @@ -1535,9 +1535,15 @@ So here is a list of contributing persons I would like to thank : and for implementing the date format configuration options * Erik Saule for its patch implementing the `-N`, `-s`, `-S`, `-r` and `-D` - flags + flags as well as support for regular expressions! -* people who write softwares I like and which inspired me, especially : +* Baptiste Jonglez and Lars Henriksen for their awesome work on many important + features of calcurse! + +* Randy Ramos for his improvements to the calcurse-caldav synchronization + script. + +* people who write software I like and which inspired me, especially: - `vim` for the displacement keys - `orpheus` and `abook` for documentation -- cgit v1.2.3-70-g09d2