Skip to content

Commit 5923974

Browse files
committed
Update and install README.md
Limit line lengths. Add issue reporting and licensing paragraphs. Add links.
1 parent 0fc5601 commit 5923974

File tree

2 files changed

+41
-7
lines changed

2 files changed

+41
-7
lines changed

CMakeLists.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ install(FILES "COPYING"
5252
RENAME COPYING.txt
5353
DESTINATION "${CMAKE_INSTALL_DOCDIR}"
5454
)
55+
install(FILES "README.md"
56+
RENAME README.txt
57+
DESTINATION "${CMAKE_INSTALL_DOCDIR}"
58+
)
5559

5660

5761
# Actual build

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,49 @@
1-
**CupCalculator** is a program which calculates scorings from race results. It takes the runners' race times and calculates points for every runner (and optionally also for teams) according to a set of rules which are specified in advance. This makes the point calculation a matter of a few clicks.
1+
# OpenOrienteering CupCalculator
22

3-
A word of warning, though: **always** do a quick check of the calculated points before publishing them! I cannot take responsibility for incorrectly calculated points.
3+
**CupCalculator** is a program which calculates scorings from race results.
4+
It takes the runners' race times and calculates points for every runner
5+
(and optionally also for teams) according to a set of rules which are specified
6+
in advance. This makes the point calculation a matter of a few clicks.
47

8+
- [CupCalculator Homepage](https://www.openorienteering.org/apps/cupcalculator/)
9+
- [Downloads](https://github.com/OpenOrienteering/cupcalculator/releases)
10+
- [OpenOrienteering Blog](https://www.openorienteering.org/)
511

6-
**Features**
712

8-
* Import race times from [Sportsoftware](http://www.sportsoftware.de) CSV exports (OE 2003 / 2010 and OS 2003 / 2010)
13+
## Features
914

10-
* Calculation of scorings for single races and series scorings, with adjustable settings including handicapping based on age
15+
* Import race times from [Sportsoftware](http://www.sportsoftware.de) CSV
16+
exports (OE 2003 / 2010 and OS 2003 / 2010)
17+
18+
* Calculation of scorings for single races and series scorings, with
19+
adjustable settings including handicapping based on age
1120

1221
* Recognition and correction of misspelled clubs & runner names
1322

1423
* Presentation mode for prize giving ceremonies
1524

16-
* Calculated scorings can be exported as CSV, to be loaded into Excel / LibreOffice Calc to prepare the results as PDF
25+
* Calculated scorings can be exported as CSV, to be loaded into Excel or
26+
LibreOffice Calc to prepare the results as PDF
27+
28+
* Languages: English and German
29+
30+
* Cross-platform open source software
31+
32+
A word of warning, though:
33+
**Always** do a quick check of the calculated points before publishing them!
34+
We cannot take responsibility for incorrectly calculated points.
35+
36+
37+
## Reporting Issues and Asking for Help
38+
39+
Issues and possible improvements can be posted to our public
40+
[Ticket system](https://github.com/OpenOrienteering/cupcalculator/issues).
41+
Please provide all relevant information about your problem or idea.
42+
1743

18-
* Works on Windows and Linux (when compiled yourself); Languages: English and German
44+
## License
1945

46+
This program is free software: you can redistribute it and/or modify
47+
it under the terms of the GNU General Public License as published by
48+
the Free Software Foundation, version 3 of the License, or
49+
(at your option) any later version.

0 commit comments

Comments
 (0)