diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 36 insertions, 3 deletions
@@ -1,4 +1,37 @@ # What is this? -This is a voice channel server that I decided to write because I am tired of bad-quality audio calls provided by all major platforms -# How to use it? -Not much here yet, because I am still learning a lot for now. But when I am ready, I will add instructions +This is a VoIP server that I decided to write because +I am tired of bad-quality audio calls provided by all major platforms. + +This readme looks more like 'future plans' or a TODO list, but whatever, +it is what it is. + +## Documentation +Can be found in `doc/`. For now, only protocols are somewhat documented + +## Build +`make` will build server, client and all tests and put them into build directory +along with all object files. If you want to customize your build destination, run +`make BLDDIR=mybuild` or customize the variable inside the makefile directly + +To build in debug mode, `make DEBUG=On`. Note that while in development, +`DEBUG` is already defined in makefile, so for now if you want a build without +debug information, please remove `DEBUG = On` line from the Makefile + +Note: I have CMakeLists.txt for now, but they are not maintained and I will +remove them in next few commits + +## Running server +`./build/server`. If built in debug mode, `kill -SIGUSR1 <pid>` will make +server print it's state (all channels and every registered user) + +## About clients +First of all: I will start working on clients when I am finished with server. + +Second: First client will probably be CLI or TUI. I have a friend who works +with android development, and he agreed to help out later. Desktop client will +probably use `fltk` or something. IOS users... I am sorry (for you). + +## Security +First priority is a working prototype, after it's ready is when i'll start +working on openSSL and all that painful stuff... +I will keep an option to stay unencrypted in favor of better sound quality. |