From 903a9911f98969d77b2f45de50f8bdb87822fa06 Mon Sep 17 00:00:00 2001
From: Simon Mossmyr <simon.mossmyr@sunstone.se>
Date: Mon, 28 Oct 2019 21:21:43 +0100
Subject: Add Linux install instructions and usage

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index d5d803e..609f86b 100644
--- a/README.md
+++ b/README.md
@@ -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`
+
-- 
cgit v1.2.3