summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJesusaves <cpntb1@ymail.com>2018-03-13 20:52:27 -0300
committerJesusaves <cpntb1@ymail.com>2018-03-13 20:52:27 -0300
commitc128836a58949fc6059a79711e6ef558919e1c43 (patch)
treebfec53ee12657277a86c9a5ce6b4ad5d027d86de
parent8afdbb5d03faae90dca96ec700dbab38fdc5fdd0 (diff)
downloadserverdata-c128836a58949fc6059a79711e6ef558919e1c43.tar.gz
serverdata-c128836a58949fc6059a79711e6ef558919e1c43.tar.bz2
serverdata-c128836a58949fc6059a79711e6ef558919e1c43.tar.xz
serverdata-c128836a58949fc6059a79711e6ef558919e1c43.zip
Update README
-rw-r--r--README.md27
1 files changed, 22 insertions, 5 deletions
diff --git a/README.md b/README.md
index 6db9979d7..84649141f 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,25 @@
# Server Data Repository
-Some minor special care is required to run.
-If there are missing files complains (eg. channels.conf),
-you should find a base file to copy over (eg. channels.conf.base)
+Please ensure you are following [Development Instructions](https://tmw2.org/development.php).
+If you could not find some package, you can try apt-cache to find it's real name.
-Just copy them and the server should run fine
-(once Evol has been successfully compiled)
+Most common required invokation is:
+
+```
+apt-cache search libpcre
+apt-cache search mariadb
+```
+
+Install the appropriate packages, including the "-dev" version if available, and
+use the following command to build everything:
+
+```
+make asan
+```
+
+If you do not have memory to spare, you can use `make new`, and it'll make a light
+build. However, shall any problem happen with Evol engine, you will most likely
+be on the dark.
+
+It will output an "OK" at the end, if everything ran fine. For support head to #tmw2-dev
+IRC channel.