From bc19ac8188ac4fcf20da987195a6e2e7bfe9b445 Mon Sep 17 00:00:00 2001
From: Roman Haefeli <reduzent@gmail.com>
Date: Thu, 15 Mar 2018 13:58:47 +0100
Subject: [PATCH] add installation section to README.txt

---
 README.txt | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.txt b/README.txt
index 14ac881..d092322 100644
--- a/README.txt
+++ b/README.txt
@@ -24,7 +24,8 @@ For more information visit:
 Installation
 ------------
 
-Make sure to get the latest Pure Data from:
+Install Pure Data with your package manager or get binaries
+from:
 
   https://puredata.info/downloads/
 
@@ -36,6 +37,33 @@ You need the following externals to run tpf-client
 You can install externals through the Pd menu:
 'Help' -> 'Find Externals'
 
+tpf-server uses netpd-server as a git submodule, thus make
+sure to clone the repository like this:
+
+  git clone --recursive https://gitlab.zhdk.ch/TPF/tpf-server
+
+
+Run tpf-server
+--------------
+
+For the server to be reachable by the clients, it should run on
+a machine with a public IP address. On a head-less machine, you
+probably want to run it in nogui mode:
+
+  pd -nogui -open tpf-server/tpf-server.pd
+
+The server opens a listening socket on TCP-port 3025. So make
+sure that this port is open in your firewall configuration.
+The TCP-Port 3025 is only used for client communication and not for
+audio transmission. The audio transmission is using UDP-Port 4460
+and requires a separate Python script to be running:
+
+  ./tpf-udp-proxy.py
+
+This waits for incoming client connections and relays UDP packets
+between clients.
+
+
 
 Authors
 -------
-- 
GitLab