StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

more tweaks to README.md

Browse Source 
Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there.
This commit is contained in:
pyrobisqit 2013-07-31 16:46:49 +02:00
parent bdd13d1954
commit d9f88fd89e
1 changed files with 30 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -1,8 +1,7 @@
![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox")
Project Tox, _also known as Tox_, is a FOSS instant messaging application aimed to replace Skype.<br />
With 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 />
Project Tox, _also known as Tox_, is a FOSS (Free and Open Source Software) instant messaging application aimed to replace Skype.<br />
With 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 />
@ -15,41 +14,40 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use
**How to build Tox on Linux**: [YouTube video](http://www.youtube.com/watch?v=M4WXE4VKmyg)<br />
**How to use Tox on Windows**: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ)
## The Complex Stuff:
+ Tox must use UDP simply because you can't hole punch with TCP. It's possible, but it doesn't work all the time.
+ Every peer is represented as a byte string (the public key of the peer [client id])
+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID.
+ 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))
+ When both peers are securely connected, they can exchange messages, initiate a video chat, send files, etc, all using encrypted communications.<br />
+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core)
### Objectives:
## Roadmap:
- [x] Get our DHT working perfectly.(Done, needs large scale testing though.)
- [x] Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example)
- [x] Encryption. (Done)
- [ ] Get a simple text only IM client working perfectly. (This is where we are)
- [ ] Streaming media
- [ ] ???
For further information, check our [To-do list](https://github.com/irungentoo/ProjectTox-Core/wiki/TODO)
### Important-stuff:
Use the same UDP socket for everything
Use the same UDP socket for everything.
Keep everything really simple.
### Details and Documents:
## The Complex Stuff:
+ Tox must use UDP simply because [hole punching](http://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
+ Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (the public key of the peer [client ID]).
+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID.
+ 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))
+ When both peers are securely connected, they can exchange messages, initiate a video chat, send files, etc, all using encrypted communications.
+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core)
## Roadmap:
- [x] Get our DHT working perfectly. (Done, needs large scale testing though)
- [x] Reliable connection (See Lossless UDP protocol) to other peers according to client ID. (Done, see DHT_sendfiletest.c for an example)
- [x] Encryption. (Done)
- [ ] Get a simple text only IM client working perfectly. (This is where we are)
- [ ] Streaming media
- [ ] ???
For further information, check our [To-do list](https://github.com/irungentoo/ProjectTox-Core/wiki/TODO)
### Why are you doing this? There are already a bunch of free skype alternatives.
The 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
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.
### Documentation:
[DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br />
[Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br />
[Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br />
[Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas)
### Why are you doing this? There are already a bunch of free skype alternatives.
The 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
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 much too centralized.