summary refs log tree commit diff stats
path: root/tests/niminaction/Chapter3/ChatApp/readme.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'tests/niminaction/Chapter3/ChatApp/readme.markdown')
-rw-r--r--tests/niminaction/Chapter3/ChatApp/readme.markdown26
1 files changed, 26 insertions, 0 deletions
diff --git a/tests/niminaction/Chapter3/ChatApp/readme.markdown b/tests/niminaction/Chapter3/ChatApp/readme.markdown
new file mode 100644
index 000000000..200b4df1d
--- /dev/null
+++ b/tests/niminaction/Chapter3/ChatApp/readme.markdown
@@ -0,0 +1,26 @@
+# The ChatApp source code
+
+This directory contains the ChatApp project, which is the project that is
+created as part of Chapter 3 of the Nim in Action book.
+
+To compile run:
+
+```
+nim c src/client
+nim c src/server
+```
+
+You can then run the ``server`` in one terminal by executing ``./src/server``.
+
+After doing so you can execute multiple clients in different terminals and have
+them communicate via the server.
+
+To execute a client, make sure to specify the server address and user name
+on the command line:
+
+```bash
+./src/client localhost Peter
+```
+
+You should then be able to start typing in messages and sending them
+by pressing the Enter key.
\ No newline at end of file