blob: 8cb39898bfdf3373cae6c22db6c18954f746693a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
# What is this?
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=1`. 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 = 1` from makefile or run `make DEBUG=0`
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.
|
