many changes in progess

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f58bcd4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+### Video call
+
+This is a simple application that uses various linux apis to send video and audio
+through udp datagram sockets
+
+### Build
+
+To build use `./build`, to clean binaries use `./build clean`
+When build it create two binaries, `listener` and `talker`
+
+### Run
+
+The `listener` listens for connections and displays the video and plays the
+audio.
+The `talker` records audio and camera and sends it.
+
+### Limitations
+
+1. 160x120 video resolution because of the limited size of sockets
+2. Crappy audio, most likely because of pulse audio
+3. Works only one linux, I don't plan porting it to windows.
+
+### TODO
+
+1. Use alsa and not pulse audio simple api
+2. Don't use glut, find a way to sync displaying and getting the video and audio data
+3. MUST run at 30 fps