TRCS-1.0.0
A 28KB, Text Relay Communications Server
--------------------------------

TRCS is a minimal-deps, optimised semi-relay server that you can spin up in
under a second. TRCS is a simple webserver interface allowing for peer-to-peer
relay messaging with a definable set resource usage settings. TRCS can be used
in many forms as it acts as a simple text-communication system, so in theory,
you could use this for anything from file transfers and basic chat applications,
to video streaming or multiplayer video game IPC.

TRCS was made to be as FAST and reliable as possible that way with very little
effort and setup. TRCS, in its current state, takes under 1 second flat to
download, compile and start. Note that this is on a somewhat stable internet
connection and this statistic may vary on different machines.

Included in this repo is trchat - a basic text client that you can use to send
content back and forth. TRCS was made to be manipulated mainly by the client
with the server just being some form of middle-man.

BUILDING/INSTALLING
-------------------

I tried to make sure that TRCS compiles on both Linux and Windows machines but
I've found that the socketing library does not compile on windows (or at least
windows compilers such as mingw-w64 non-native or tdm-gcc native). TRCS compiles
perfectly fine on both GNU/Linux and OS-X. Windows support is not planned for
the server but In the future I may create a python client for multi-platform
users.

TRCS uses zero non-standard dependencies, trchat requires libcurl. In order to
make the project you require the basic gnu coreutils, specifically you require
cc and make. These are optional as make is just used for build scripting and
cc can be swapped for any compiler of your choice.

Download:
git clone https://github.com/x3hy/trcs
cd trcs

TL;DR:
	run `make demo` to connect to the public server instance
	run `make start` to start the server

BUILD OPTIONS
-------------

make [OPTION] PORT=INT USERNAME=STR HOST=STR
OPTIONS:
	trcs     | Compile the server to trcs binary
	trchat   | Compile the char to trchat binary
	start    | Compile and start the trcs server
	client   | Compile and start the trchat client
	debug    | Compile trcs and run with gdb
	demo     | Use trchat to connect to the public trcs server
	clean    | Remove compilation and temporary files
	.version | Generates the .version based off of git version
	           Also appends version and size to the README

Notes:
	PORT must be a value between 1025 and 65585
	USERNAME must be a single word tag used for user id (does not have to be
	         unique)
	HOST - the hostname address of the server to connect too.
	Read the Makefile for more information