commit 9423a603

Poul Sander · 2019-06-09 13:15
9423a6036997a390311c758c7e334d083b47a951 patch · browse files
parent 691a31528daac506f82cbcbb0644dd463ba42525

Update README.md

Changed files

M	README.md before

diff --git a/README.md b/README.md index eae2f52..ced3b70 100644 --- a/README.md +++ b/README.md

@@ -1,8 +1,28 @@

# oastat_static_web_generator

A program to generate static HTML files like the ones from pyqscore but from oastat data.

+OaStat: https://github.com/sago007/oastat

+An example can be seen on: https://oastat.poulsander.com/oastat_static_web/

+## Cloning and building

+This repository has a sub modules with levelshots and modelshots. Therefore it must be cloned like:

+```

+git clone --recurse-submodules https://github.com/sago007/oastat_static_web_generator.git

+```

+Building:

+```

+cmake .

+make

+```

+## Usage

+The program expects the environment variable SAGO_CONNECTION_STRING to be set and pointing to a database populated by OaStat.

+Only mysql has been tested.

+```

+SAGO_CONNECTION_STRING="mysql:database=oastat;user=openarena;pass=Password1234" ./oastat_static_web_generator --output-dir ./output

+```

## LICENSE

The code is GPLv2 or later.