From 89b2128d0b6bcc368dcb26465411202b0e833fda Mon Sep 17 00:00:00 2001 From: JamesMcCrae Date: Tue, 2 Jul 2019 21:00:37 -0400 Subject: [PATCH] update build instructions in readme.md --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3383f35..5743c3e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,14 @@ Janus Presence Server, C++ implementation Build with Qt 5. Requires linking with the QtNetwork module (included in a typical Qt SDK install). -On Windows/Linux where Qt Creator is installed: open the project file (janus-server-c.pro) and start a release build. A janus-server-c executable will be built. +On Windows/Linux where Qt Creator is installed: open the project file (janus-server-c.pro) and start a release build. On Linux where no GUI is available (assumes Qt5 SDK is installed): + +> qmake -makefile +> make + +and a `janus-server-c` binary will be created. Run with: + +> ./janus-server-c ### General Features @@ -23,7 +30,7 @@ You can test that the server is up by using telnet. > telnet localhost 5566 -Copy and paste the examples below to see how it works +Copy and paste the examples below to see how it works (which also serve as protocol documentation): ================================= ### 1. Client -> Server Methods: @@ -356,4 +363,4 @@ When a user disconnects: ```json {"method":"user_disconnected","data":{"userId":"LL"}} -``` \ No newline at end of file +```