kopia lustrzana https://gitlab.com/tomaszg/geostat
Update README.md and usage notes
rodzic
8bcd122621
commit
acc16d1dbf
20
README.md
20
README.md
|
@ -4,12 +4,12 @@ GEOSTAT
|
|||
Tools for computing various statistics related to Geocaching/Opencaching
|
||||
------------------------------------------------------------------------
|
||||
|
||||
### Sample web interface
|
||||
# Sample web interface
|
||||
|
||||
A sample web interface to play with the tool is available at http://tomaszg.pl/geo/.
|
||||
|
||||
|
||||
### Usage
|
||||
# Usage
|
||||
|
||||
The main tool is called `geostat`. It is able to access `opencaching.pl` via `OKAPI` or from local database dump maintained by `geodb`. It can also partially read `GPX` files, e.g. exported from [c:geo](https://www.cgeo.org/). It produces various statistics (either as text output with `geostat_cli`, or in a HTML form with `geostat`) and renders a heat map of found/not found caches in a selected region. HTML output requires a style sheet. Sample one is included as `geo.css`.
|
||||
|
||||
|
@ -42,6 +42,9 @@ Generate HTML stats from Opencaching data or GPX files.
|
|||
-h display this help screen
|
||||
```
|
||||
|
||||
# Other tools
|
||||
|
||||
## geodb
|
||||
There is a helper program `geodb` which manages local SQLite database. It can initialize the database from full data dump or update it according to changelogs grabbed from OKAPI.
|
||||
|
||||
```
|
||||
|
@ -52,7 +55,16 @@ Manage local Opencaching database.
|
|||
-h display this help screen
|
||||
```
|
||||
|
||||
### Installation
|
||||
## geofriends
|
||||
Another tools is `geofriends`. It generates stats for a pair of users regarding their common caching activities.
|
||||
|
||||
```
|
||||
Usage: geofriends nick1 nick2
|
||||
Generate HTML stats for user caching intersection from Opencaching data.
|
||||
```
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
To compile it requires:
|
||||
|
||||
|
@ -67,7 +79,7 @@ To compile it requires:
|
|||
To build the project copy `config_user_example.h` to `config_user.h` and fill it out (at least API key is needed). Then
|
||||
run `meson build; cd build; ninja`. You might need to set `CXX` variable to point to a correct compiler.
|
||||
|
||||
### Credits
|
||||
# Credits
|
||||
|
||||
* Maps of Poland `Poland.png` and `Poland_big.png` come from https://pl.wikipedia.org/wiki/Plik:Poland_location_map.svg and are licensed under CC-BY-SA and GNU FDL.
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@
|
|||
#include <unistd.h>
|
||||
|
||||
void show_usage() {
|
||||
std::cout << "Usage: geofriends [options] nick1 nick2\n";
|
||||
std::cout << "Usage: geofriends nick1 nick2\n";
|
||||
std::cout << "Generate HTML stats for user caching intersection from Opencaching data.\n\n";
|
||||
std::exit(EXIT_FAILURE);
|
||||
}
|
||||
|
|
Ładowanie…
Reference in New Issue