diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
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` + |