diff options
| author | Ladislav Zezula <zezula@volny.cz> | 2019-10-29 06:13:16 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-29 06:13:16 +0100 |
| commit | c00454ead06f84e6736f3ab74c3af61da65ad0d1 (patch) | |
| tree | 90e5892537c744e2286e38fe3aa99e50ce56e3e0 | |
| parent | 4f2c5770f6ae552977e1fe0cd0618c90050ad25a (diff) | |
| parent | 903a9911f98969d77b2f45de50f8bdb87822fa06 (diff) | |
Merge pull request #161 from SimonMossmyr/master
Merged. Thank you for your contribution.
| -rw-r--r-- | README | 1 | ||||
| -rw-r--r-- | README.md | 17 |
2 files changed, 17 insertions, 1 deletions
@@ -1 +0,0 @@ -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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..609f86b --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# 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` + |