summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Lohle <David@Tox.im>2014-03-14 17:22:22 -0400
committerDavid Lohle <David@Tox.im>2014-03-14 17:22:22 -0400
commit116467f659abbe4660486b3a5c4c4b64d7768a50 (patch)
tree40a33a9ae71e5aab888fcd4ef76ac41c58d1f0d3 /README.md
parent3acf43b76accbe0285e9cec0ff3536efeb3f8d8c (diff)
Organize the Readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 18 insertions, 25 deletions
diff --git a/README.md b/README.md
index 4e6ebf0e..55b777c9 100644
--- a/README.md
+++ b/README.md
@@ -1,43 +1,36 @@
1![Project Tox](https://raw.github.com/irungentoo/ProjectTox-Core/master/other/tox.png "Project Tox") 1![Project Tox](https://raw.github.com/irungentoo/ProjectTox-Core/master/other/tox.png "Project Tox")
2Project Tox, _also known as Tox_, is a FOSS (Free and Open Source Software) instant messaging application aimed to replace Skype.<br /> 2***
3 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 /> 4With the rise of governmental monitoring programs, Tox, a FOSS initiative, aims to be an easy to use, all-in-one communication platform that ensures their users full privacy and secure message delivery.<br /> <br />
5 5
6[**Website**](https://tox.im) **|** [**Wiki**](http://wiki.tox.im/) **|** [**Blog**](https://blog.libtoxcore.so/) **|** [**FAQ**](http://wiki.tox.im/FAQ) **|** [**Binaries**](http://download.tox.im/) **|** [**Clients**](http://wiki.tox.im/Client) **|** [**Compiling**](http://wiki.tox.im/Installing) **|** [**API**](http://api.libtoxcore.so/) **|** **IRC:** #tox@freenode
6 7
7 8
8**IRC**: #tox on freenode, alternatively, you can use the [webchat](https://webchat.freenode.net/?channels=#tox).<br /> 9## The Complex Stuff:
9**Website**: [https://tox.im](https://tox.im)<br> 10### UDP vs. TCP
10**Jenkins**: [http://jenkins.tox.im](http://jenkins.tox.im)<br> 11Tox must use UDP simply because [hole punching](http://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
11**Nightly Binary Downloads***: [http://download.tox.im](http://download.tox.im)
12 12
13**Website translations**: [here](https://github.com/Tox/tox.im)<br/> 13### Connecting & Communicating
14**Qt GUI**: [see nurupo's repository](https://github.com/nurupo/ProjectTox-Qt-GUI) 14Every peer is represented as a [byte string][String] (the public key [Tox ID] of the peer). By using torrent-style DHT, peers can find the IP of other peers by using their Tox ID. Once the IP is obtained, peers can initiate a [secure](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto) connection with each other. Once the connection is made, peers can exchange messages, send files, start video chats, etc. using encrypted communications.
15 15
16**How to build Tox** [INSTALL.md](INSTALL.md)
17 16
18### Objectives: 17**Current build status:** [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core)
19 18
20Keep everything really simple.
21 19
22## The Complex Stuff: 20## Q&A:
23+ Tox must use UDP simply because [hole punching](http://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable. 21
24+ Every peer is represented as a [byte string][String] (the public key of the peer [client ID]). 22### What are your goals of Tox?
25+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID. 23
26+ 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)) 24We want Tox to be as simple as possible while remaining as secure as possible.
27+ When both peers are securely connected, they can exchange messages, initiate a video chat, send files, etc, all using encrypted communications. 25
28+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core) 26### Why are you doing this? There are already a bunch of free Skype alternatives.
27The goal of this project is to create a configuration-free P2P Skype replacement. Configuration-free means that the user will simply have to open the program and without any account configuration will be capable of adding people to his or her's friends list and start conversing with them. There are many so-called Skype replacements and all of them are either hard to configure for the normal user or suffer from being way too centralized.
29 28
30## TODO: 29## TODO:
31- [TODO](/docs/TODO) 30- [TODO](/docs/TODO)
32 31
33### Why are you doing this? There are already a bunch of free skype alternatives.
34The goal of this project is to create a configuration-free P2P skype
35replacement. Configuration-free means that the user will simply have to open the program and
36without any account configuration will be capable of adding people to his
37friends list and start conversing with them. There are many so-called skype replacements and all of them are either hard to
38configure for the normal user or suffer from being way too centralized.
39 32
40### Documentation: 33## Documentation:
41 34
42- [Installation](/INSTALL.md) 35- [Installation](/INSTALL.md)
43- [DHT Protocol](http://wiki.tox.im/index.php/DHT)<br /> 36- [DHT Protocol](http://wiki.tox.im/index.php/DHT)<br />