doc/index.texi

   1 \input texinfo
   2 @settitle VoRS
   3
   4 @copying
   5 Copyright @copyright{} 2024 @email{stargrave@@stargrave.org, Sergey Matveev}
   6 @end copying
   7
   8 @node Top
   9 @top VoRS
  10
  11 VoRS -- Vo(IP) Really Simple.
  12 Very simple and usable multi-user VoIP solution.
  13 Some kind of alternative to @url{https://www.mumble.info/, Mumble}.
  14
  15 But why? SIP-based solutions are pretty complicated to setup, because
  16 they are not made for simple tasks like sudden voice chats between a
  17 few people. WebRTC-based solutions are insane bloated incredible
  18 monsters by complexity and size, hardly possible to debug and having
  19 frequent compatibility problems. They work mainly only if you use the
  20 same kind of software and codecs, for example Chromium, that requires
  21 dozens of gigabytes of disk space and much RAM, CPU time to build it.
  22 Taking an enormous amount of CPU power to slowly work with it. Is not
  23 it pure insanity for such relatively simple task?
  24
  25 Mumble has wonderful simplicity and workability, but its client is
  26 written on Qt, which requires hundreds of megabytes of additional
  27 libraries to build it up. And users tend to complain about its newer
  28 client versions quality and convenience.
  29
  30 So let's write as simple VoIP talking client as it is possible, without
  31 compromising convenience and simplicity for the user! I just want a
  32 simple command, which only requires to specify the server's address with
  33 the key to just immediately talk with someone.
  34
  35 @itemize
  36
  37 @item No GUI requirement. Why would someone need a GUI for voice
  38 application? But a fancy real-time refreshing TUI would be desirable.
  39 Mumble tends to output no information, sometimes hiding the fact of a
  40 problem and that everything stopped working.
  41
  42 @item Mono-cypher, mono-codec protocol.
  43
  44 @item Maximal easiness of usage: here is your address, key, do me good.
  45
  46 @end itemize
  47
  48 VoRS is
  49 @url{https://www.gnu.org/philosophy/pragmatic.html, copylefted}
  50 @url{https://www.gnu.org/philosophy/free-sw.html, free software}
  51 licenced under @url{https://www.gnu.org/licenses/agpl.html, GNU Affero GPLv3}.
  52 It should work on all
  53 @url{https://en.wikipedia.org/wiki/POSIX, POSIX}-compatible systems.
  54
  55 @float
  56 @image{screenshots/example,,,Server and two clients,.webp}
  57 @caption{Server (above) and two clients (left and right) in a terminal multiplexer}
  58 @end float
  59
  60 @include features.texi
  61 @include install.texi
  62 @include usage.texi
  63 @include vad.texi
  64 @include proto.texi
  65
  66 @bye