toxcore/README.md

![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox")
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 />


**IRC**: #tox on freenode, alternatively, you can use the [webchat](http://webchat.freenode.net/?channels=#tox).<br />
**Website**: [http://tox.im](http://tox.im)
**Developer Blog**: [http://dev.tox.im](http://dev.tox.im)

**Website translations**: [see stal888's repository](https://github.com/stal888/ProjectTox-Website)<br/>
**Qt GUI**: [see nurupo's repository](https://github.com/nurupo/ProjectTox-Qt-GUI)

**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)<br />
**For Mac OSX read** [INSTALL.md](INSTALL.md)

### Objectives:

Keep everything really simple.

## 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](http://wiki.tox.im/index.php/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:

- [Installation](/INSTALL.md)
- [Commands](/docs/commands.rst)
- [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)
Update readme; I'm vain like that. 2013-07-19 10:32:28 +08:00			`![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox")`
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`Project Tox, _also known as Tox_, is a FOSS (Free and Open Source Software) instant messaging application aimed to replace Skype.<br />`
Add Travis-CI status image 2013-07-09 05:13:29 +08:00
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`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 />`
Added IRC. 2013-06-24 08:42:35 +08:00

Update README.md 2013-06-24 08:15:33 +08:00
README.md: s/Freenode/freenode/ 2013-07-31 06:25:00 +08:00			`IRC: #tox on freenode, alternatively, you can use the [webchat](http://webchat.freenode.net/?channels=#tox).<br />`
We've updated our URL 2013-07-21 15:44:58 +08:00			`Website: [http://tox.im](http://tox.im)`
Update readme to refer to new developer blog. If you need an account on the CMS; contact me on IRC. 2013-08-03 23:14:00 +08:00			`Developer Blog: [http://dev.tox.im](http://dev.tox.im)`
Update README.md 2013-06-24 08:15:33 +08:00
Update README.md Added several links to closely related repo's 2013-07-24 07:00:02 +08:00			`Website translations: [see stal888's repository](https://github.com/stal888/ProjectTox-Website)<br/>`
			`Qt GUI: [see nurupo's repository](https://github.com/nurupo/ProjectTox-Qt-GUI)`

break line 2013-07-31 07:03:39 +08:00			`How to build Tox on Linux: [YouTube video](http://www.youtube.com/watch?v=M4WXE4VKmyg)<br />`
mac on homepage 2013-08-01 18:18:36 +08:00			`How to use Tox on Windows: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ)<br />`
The bold INSTALL.md did not look correct 2013-08-02 19:30:46 +08:00			`For Mac OSX read [INSTALL.md](INSTALL.md)`
Update readme; I'm vain like that. 2013-07-19 10:32:28 +08:00
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`### Objectives:`

			`Keep everything really simple.`

Schematics & build status 2013-07-19 12:10:18 +08:00			`## The Complex Stuff:`
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`+ 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]).`
Update readme; I'm vain like that. 2013-07-19 10:32:28 +08:00			`+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID.`
Typo in readme fixed. 2013-07-30 20:43:44 +08:00			`+ 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))`
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`+ 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)`
Update README.md 2013-06-24 08:15:33 +08:00
Testing if removing the after-hash marks is valid markdown 2013-06-26 06:52:34 +08:00			`## Roadmap:`
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`- [x] Get our DHT working perfectly. (Done, needs large scale testing though)`
touch up docs to link to eachother 2013-08-01 05:06:04 +08:00			- [x] Reliable connection (See Lossless UDP protocol) to other peers according to client ID. (Done, see `DHT_sendfiletest.c` for an example)
Update readme; I'm vain like that. 2013-07-19 10:32:28 +08:00			`- [x] Encryption. (Done)`
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`- [ ] Get a simple text only IM client working perfectly. (This is where we are)`
			`- [ ] Streaming media`
			`- [ ] ???`
Update README.md 2013-06-24 08:15:33 +08:00
Updated the readme to the new wiki page, linked the Mac OSX INSTALL.md 2013-08-02 19:27:41 +08:00			`For further information, check our [To-do list](http://wiki.tox.im/index.php/TODO)`
Update README.md 2013-06-24 08:15:33 +08:00
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`### 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`
so-called 2013-08-02 03:48:10 +08:00			`friends list and start conversing with them. There are many so-called skype replacements and all of them are either hard to`
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`configure for the normal user or suffer from being way too centralized.`
Fixed one possible bug in the DHT and added a basic TODO list. Fixed a possible segfault which could have been cause by handling an empty packet. 2013-06-26 05:16:45 +08:00
more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. 2013-07-31 22:46:49 +08:00			`### Documentation:`
Update README.md 2013-06-24 08:15:33 +08:00
touch up docs to link to eachother 2013-08-01 05:06:04 +08:00			`- [Installation](/INSTALL.md)`
Update README.md Added link to commands.rst 2013-08-02 22:55:57 +08:00			`- [Commands](/docs/commands.rst)`
touch up docs to link to eachother 2013-08-01 05:06:04 +08:00			`- [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)`