diff options
| author | Simon Mossmyr <simon.mossmyr@sunstone.se> | 2019-10-28 21:21:43 +0100 |
|---|---|---|
| committer | Simon Mossmyr <simon.mossmyr@sunstone.se> | 2019-10-28 21:21:43 +0100 |
| commit | 903a9911f98969d77b2f45de50f8bdb87822fa06 (patch) | |
| tree | 90e5892537c744e2286e38fe3aa99e50ce56e3e0 | |
| parent | 9f70b5e00054218e46143783a19f8e6a35819e56 (diff) | |
Add Linux install instructions and usage
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -1 +1,17 @@ -This is official repository for the StomLib library, an open-source project that can work with Blizzard MPQ archives.
\ No newline at end of file +# StormLib + +This is official repository for the StomLib library, an open-source project that can work with Blizzard MPQ archives. + +## Installation and basic usage +### Linux +1. Download latest release +2. Install StormLib: +``` +$ cd <path-to-StormLib> +$ cmake CMakeLists.txt +$ make +$ make install +``` +3. Include StormLib in your project: `#include <StormLib.h>` +4. Make sure you compile your project with `-lstorm -lz -lbz2` + |