summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpyrobisqit <pyrobisqit@gmail.com>2013-07-31 16:46:49 +0200
committerpyrobisqit <pyrobisqit@gmail.com>2013-07-31 16:46:49 +0200
commitd9f88fd89ea37119cbfc64551251e33b20e507b0 (patch)
treea23b398dc5a048e509812f7e1bcfc0034d478516
parentbdd13d1954e0befb1682cf1f6727e9b382450ed8 (diff)
more tweaks to README.md
Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there.
-rw-r--r--README.md50
1 files changed, 24 insertions, 26 deletions
diff --git a/README.md b/README.md
index 19bbb759..db0f551c 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,7 @@
1![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox") 1![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox")
2Project Tox, _also known as Tox_, is a FOSS instant messaging application aimed to replace Skype.<br /> 2Project Tox, _also known as Tox_, is a FOSS (Free and Open Source Software) instant messaging application aimed to replace Skype.<br />
3
4With the rise of governmental monitoring programs, Tox aims to be an easy to use application that allows people to connect with friends and loved ones without the worry of privacy.<br /> <br />
5 3
4With the rise of governmental monitoring programs, Tox aims to be an easy to use, all-in-one communication platform (including audio, and videochats in the future) that ensures their users full privacy and secure message delivery.<br /> <br />
6 5
7 6
8 7
@@ -15,41 +14,40 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use
15**How to build Tox on Linux**: [YouTube video](http://www.youtube.com/watch?v=M4WXE4VKmyg)<br /> 14**How to build Tox on Linux**: [YouTube video](http://www.youtube.com/watch?v=M4WXE4VKmyg)<br />
16**How to use Tox on Windows**: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ) 15**How to use Tox on Windows**: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ)
17 16
17### Objectives:
18
19Use the same UDP socket for everything.
20
21Keep everything really simple.
22
18## The Complex Stuff: 23## The Complex Stuff:
19+ Tox must use UDP simply because you can't hole punch with TCP. It's possible, but it doesn't work all the time. 24+ Tox must use UDP simply because [hole punching](http://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
20+ Every peer is represented as a byte string (the public key of the peer [client id]) 25+ Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (the public key of the peer [client ID]).
21+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID. 26+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID.
22+ Once the client has the IP of that peer, they start initiating a secure connection with each other. (See [Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)) 27+ Once the client has the IP of that peer, they start initiating a secure connection with each other. (See [Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto))
23+ When both peers are securely connected, they can exchange messages, initiate a video chat, send files, etc, all using encrypted communications.<br /> 28+ When both peers are securely connected, they can exchange messages, initiate a video chat, send files, etc, all using encrypted communications.
24+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core) 29+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core)
25 30
26## Roadmap: 31## Roadmap:
27- [x] Get our DHT working perfectly.(Done, needs large scale testing though.) 32- [x] Get our DHT working perfectly. (Done, needs large scale testing though)
28- [x] Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example) 33- [x] Reliable connection (See Lossless UDP protocol) to other peers according to client ID. (Done, see DHT_sendfiletest.c for an example)
29- [x] Encryption. (Done) 34- [x] Encryption. (Done)
30- [ ] Get a simple text only IM client working perfectly. (This is where we are) 35- [ ] Get a simple text only IM client working perfectly. (This is where we are)
31- [ ] Streaming media 36- [ ] Streaming media
32- [ ] ??? 37- [ ] ???
33 38
34For further information, check our [To-do list](https://github.com/irungentoo/ProjectTox-Core/wiki/TODO) 39For further information, check our [To-do list](https://github.com/irungentoo/ProjectTox-Core/wiki/TODO)
35 40
41### Why are you doing this? There are already a bunch of free skype alternatives.
42The goal of this project is to create a configuration-free P2P skype
43replacement. Configuration-free means that the user will simply have to open the program and
44without any account configuration will be capable of adding people to his
45friends list and start conversing with them. There are many so called skype replacements and all of them are either hard to
46configure for the normal user or suffer from being way too centralized.
36 47
37### Important-stuff: 48### Documentation:
38
39Use the same UDP socket for everything
40
41Keep everything really simple.
42
43### Details and Documents:
44 49
45[DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br /> 50[DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br />
46[Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br /> 51[Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br />
47[Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br /> 52[Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br />
48[Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas) 53[Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas)
49
50### Why are you doing this? There are already a bunch of free skype alternatives.
51The goal of this project is to create a configuration-free p2p skype
52replacement. Configuration-free means that the user will simply have to open the program and
53without any account configuration will be capable of adding people to his
54friends list and start conversing with them. There are many so called skype replacements and all of them are either hard to
55configure for the normal user or suffer from being much too centralized.