summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefano Borzì <stefanoborzi32@gmail.com>2020-01-20 23:05:13 +0100
committerGitHub <noreply@github.com>2020-01-20 23:05:13 +0100
commitf05c2d63f6baa9c563eb31786421e28f27e82721 (patch)
tree9b6e6a0c349c21a5adbc6637eb764612b64f39f0
parent2f1506914f093157e67b2634aeddafc257f3b5d2 (diff)
downloadwiki-f05c2d63f6baa9c563eb31786421e28f27e82721.tar.gz
wiki-f05c2d63f6baa9c563eb31786421e28f27e82721.tar.bz2
wiki-f05c2d63f6baa9c563eb31786421e28f27e82721.zip
Added documentation for development (#144)
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4e9ed9c..e9cf5ea 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
-# aZerothCore WIKI
+# AzerothCore WIKI
+
+Wiki for the AzerothCore Project available here: http://azerothcore.github.io/wiki
+
+## How to install locally (development)
+
+First of all install the [ruby development environment](https://jekyllrb.com/docs/installation/) using [this guide](https://jekyllrb.com/docs/installation/).
+
+After that install `bundler` using gem and run `bundler install`:
+```
+$ gem install bundler
+$ bundle install
+```
+
+Well, now you can run locally the app using:
+```
+bundle exec jekyll serve
+```
+
+If everything succeds, you can visit your web app at `http://127.0.0.1:4000/`.
+
+Any problems? [Open a issue](https://github.com/azerothcore/wiki/issues/new).
-wiki for the aZerothCore Project available here: http://azerothcore.github.io/wiki