Added a couple of lines to the readme.

2024-06-21 00:22:15 +02:00
parent 8f958359e9
commit b61dd29e00
1 changed files with 10 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
 Files for tbaMUD.

+---

+## To build
+
+1. clone the munit library into src/munit. It is registered as a submodule in git `git submodule init`
+2. run configure: `./configure`
+3. build the code: `cd src && make`
+4. run the mud: `cd ..; bin/circle 1234`
+5. connect via telnet to port 1234.
+
+Read more in the doc/ folder