From dbdeb670e467eac430789c6ec8f03ebad7a5edf1 Mon Sep 17 00:00:00 2001 From: irungentoo Date: Tue, 30 Jul 2013 08:43:44 -0400 Subject: Typo in readme fixed. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b4381bc9..8f903bc0 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use + 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) ++ 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 connect with the encryption, they can securely exchange messages, initiate a video chat, send files, etc.
+ Current build status: [![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core) -- cgit v1.2.3 From 2696134363a802fd4cb510899fed469a253087d0 Mon Sep 17 00:00:00 2001 From: Richard Hartmann Date: Wed, 31 Jul 2013 00:25:00 +0200 Subject: README.md: s/Freenode/freenode/ --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8f903bc0..efbfc05d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use -**IRC**: #tox on Freenode, alternatively, you can use the [webchat](http://webchat.freenode.net/?channels=#tox).
+**IRC**: #tox on freenode, alternatively, you can use the [webchat](http://webchat.freenode.net/?channels=#tox).
**Website**: [http://tox.im](http://tox.im) **Website translations**: [see stal888's repository](https://github.com/stal888/ProjectTox-Website)
-- cgit v1.2.3 From 0e091f7c58ffcfce82e1384b6ed4faab6a6b6222 Mon Sep 17 00:00:00 2001 From: NemDiggers Date: Tue, 30 Jul 2013 19:03:04 -0400 Subject: Add tutorial videos to readme I promise they're legit<3 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index efbfc05d..89379473 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use **Website translations**: [see stal888's repository](https://github.com/stal888/ProjectTox-Website)
**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) +**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. -- cgit v1.2.3 From d169e68450bb7a5f8de65e43b46f1102e378943a Mon Sep 17 00:00:00 2001 From: NemDiggers Date: Tue, 30 Jul 2013 19:03:39 -0400 Subject: break line --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 89379473..e6e6fe5d 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use **Website translations**: [see stal888's repository](https://github.com/stal888/ProjectTox-Website)
**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) +**How to build Tox on Linux**: [YouTube video](http://www.youtube.com/watch?v=M4WXE4VKmyg)
**How to use Tox on Windows**: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ) ## The Complex Stuff: -- cgit v1.2.3 From bd8ba0bd6e4a71eab2216749d732aa40088c95b8 Mon Sep 17 00:00:00 2001 From: pyrobisqit Date: Wed, 31 Jul 2013 03:17:40 +0200 Subject: Update readme.md Basically, a few words tweaked here and there, to make the file more gramatically correct. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e6e6fe5d..19bbb759 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,14 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use + 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 connect with the encryption, they can securely exchange messages, initiate a video chat, send files, etc.
++ 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) +- [ ] Get a simple text only IM client working perfectly. (This is where we are) - [ ] Streaming media - [ ] ??? -- cgit v1.2.3 From d9f88fd89ea37119cbfc64551251e33b20e507b0 Mon Sep 17 00:00:00 2001 From: pyrobisqit Date: Wed, 31 Jul 2013 16:46:49 +0200 Subject: more tweaks to README.md Simplified a few blocks and made it easier to read, corrected punctuation and bits here and there. --- README.md | 50 ++++++++++++++++++++++++-------------------------- 1 file changed, 24 insertions(+), 26 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 19bbb759..db0f551c 100644 --- a/README.md +++ b/README.md @@ -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.
- -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.

+Project Tox, _also known as Tox_, is a FOSS (Free and Open Source Software) instant messaging application aimed to replace Skype.
+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.

@@ -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)
**How to use Tox on Windows**: [YouTube video](http://www.youtube.com/watch?v=qg_j_sDb6WQ) +### Objectives: + +Use the same UDP socket for everything. + +Keep everything really simple. + ## 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]) ++ 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) ++ 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] 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 -- [ ] ??? +- [ ] 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. -### Important-stuff: - -Use the same UDP socket for everything - -Keep everything really simple. - -### Details and Documents: +### Documentation: [DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)
[Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)
[Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)
[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. -- cgit v1.2.3 From d0888f750c59433eb46828f24274da3cd9bd4b76 Mon Sep 17 00:00:00 2001 From: irungentoo Date: Wed, 31 Jul 2013 12:44:03 -0400 Subject: Fixed something in readme. --- README.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index db0f551c..499d8202 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,6 @@ With the rise of governmental monitoring programs, Tox aims to be an easy to use ### Objectives: -Use the same UDP socket for everything. - Keep everything really simple. ## The Complex Stuff: -- cgit v1.2.3