mirror of
https://github.com/irungentoo/toxcore.git
synced 2024-03-22 13:30:51 +08:00
Update readme with tentative roadmap, removed old todo.md
This commit is contained in:
Gregory Mullen (grayhatter)
parent
35932b5381
commit
e43bde37ea
61
README.md
61
README.md
|
|
@ -4,12 +4,51 @@
|
||||||
**Current build status:** [](https://travis-ci.org/TokTok/toxcore)
|
**Current build status:** [](https://travis-ci.org/TokTok/toxcore)
|
||||||
**Current Coverage:** [](https://coveralls.io/github/TokTok/toxcore?branch=master)
|
**Current Coverage:** [](https://coveralls.io/github/TokTok/toxcore?branch=master)
|
||||||
|
|
||||||
With the rise of government surveillance programs, Tox, a FOSS initiative, aims to be an easy to use, all-in-one communication platform that ensures full privacy and secure message delivery.<br /> <br />
|
|
||||||
|
|
||||||
[**Website**](https://tox.chat) **|** [**Wiki**](https://wiki.tox.chat/) **|** [**Blog**](https://blog.tox.chat/) **|** [**FAQ**](https://wiki.tox.chat/doku.php?id=users:faq) **|** [**Binaries/Downloads**](https://wiki.tox.chat/Binaries) **|** [**Clients**](https://wiki.tox.chat/doku.php?id=clients) **|** [**Compiling**](/INSTALL.md)
|
[**Website**](https://tox.chat) **|** [**Wiki**](https://wiki.tox.chat/) **|** [**Blog**](https://blog.tox.chat/) **|** [**FAQ**](https://wiki.tox.chat/doku.php?id=users:faq) **|** [**Binaries/Downloads**](https://wiki.tox.chat/Binaries) **|** [**Clients**](https://wiki.tox.chat/doku.php?id=clients) **|** [**Compiling**](/INSTALL.md)
|
||||||
|
|
||||||
**IRC Channels:** [#tox@freenode](https://webchat.freenode.net/?channels=tox), [#toktok@freenode](https://webchat.freenode.net/?channels=toktok)
|
**IRC Channels:** [#tox@freenode](https://webchat.freenode.net/?channels=tox), [#toktok@freenode](https://webchat.freenode.net/?channels=toktok)
|
||||||
|
|
||||||
|
## Q&A:
|
||||||
|
|
||||||
|
### What is Tox?
|
||||||
|
|
||||||
|
Tox is a fully encrypted, censor resistant, private, distributed network library with a focus on personal communications.
|
||||||
|
|
||||||
|
### No, really, what's Tox?
|
||||||
|
|
||||||
|
It's a VERY secure Instant Messenger that supports Text, Audio/Video calls, group chats, audio group chats, and file transfers.
|
||||||
|
|
||||||
|
### What are your goals with Tox?
|
||||||
|
|
||||||
|
We want Tox to be as simple as possible while remaining as secure as possible.
|
||||||
|
|
||||||
|
## Toxcore Roadmap
|
||||||
|
This Roadmap is somewhat tentative, but should give you a good idea of where
|
||||||
|
we're going, and where we've been.
|
||||||
|
|
||||||
|
Currently unsorted, the following is intended to function as a discussion guide
|
||||||
|
to developers/contributors.
|
||||||
|
|
||||||
|
### In Progress
|
||||||
|
- [ ] 100% unit testing
|
||||||
|
- [ ] Make toxcore stateless
|
||||||
|
- [ ] Allow a single toxcore instance to handle multiple keypairs
|
||||||
|
- [ ] Implement usable group chats
|
||||||
|
- [ ] Improve A/V implementation
|
||||||
|
- [ ] Multiple device support
|
||||||
|
- [ ] Consistent naming scheme throughout toxcore
|
||||||
|
|
||||||
|
### Done
|
||||||
|
- [X] Create Toxcore
|
||||||
|
- [X] Create DHT
|
||||||
|
- [X] Create Onion
|
||||||
|
- [X] Implement Crypto
|
||||||
|
- [X] Create Messenger
|
||||||
|
|
||||||
|
## Documentation:
|
||||||
|
- [Compiling](/INSTALL.md)
|
||||||
|
- [DHT Protocol](/docs/updates/DHT.md)<br />
|
||||||
|
- [Crypto](/docs/updates/Crypto.md)<br />
|
||||||
|
|
||||||
## The Complex Stuff:
|
## The Complex Stuff:
|
||||||
### UDP vs. TCP
|
### UDP vs. TCP
|
||||||
|
|
@ -20,21 +59,3 @@ However, Tox does use [TCP relays](/docs/TCP_Network.txt) as a fallback if it en
|
||||||
Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (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](/docs/updates/Crypto.md) connection with each other. Once the connection is made, peers can exchange messages, send files, start video chats, etc. using encrypted communications.
|
Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (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](/docs/updates/Crypto.md) connection with each other. Once the connection is made, peers can exchange messages, send files, start video chats, etc. using encrypted communications.
|
||||||
|
|
||||||
|
|
||||||
## Q&A:
|
|
||||||
|
|
||||||
### What are your goals with Tox?
|
|
||||||
|
|
||||||
We want Tox to be as simple as possible while remaining as secure as possible.
|
|
||||||
|
|
||||||
### 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 will be capable of adding people and communicating with them without having to set up an account. There are many so-called Skype replacements, but all of them are either hard to configure for the normal user or suffer from being way too centralized.
|
|
||||||
|
|
||||||
## TODO:
|
|
||||||
- [TODO](/docs/TODO.md)
|
|
||||||
|
|
||||||
|
|
||||||
## Documentation:
|
|
||||||
|
|
||||||
- [Compiling](/INSTALL.md)
|
|
||||||
- [DHT Protocol](/docs/updates/DHT.md)<br />
|
|
||||||
- [Crypto](/docs/updates/Crypto.md)<br />
|
|
||||||
|
|
|
||||||
46
docs/TODO.md
46
docs/TODO.md
|
|
@ -1,46 +0,0 @@
|
||||||
# Toxcore todo list.
|
|
||||||
Welcome to the Toxcore todo list, this is very likely out of date, but either way it's a good jumping off point if
|
|
||||||
you're looking to see where core is going, or where it could use a little love.
|
|
||||||
|
|
||||||
There are 3 sections; In Progress, TODO, and Done. These tasks are somewhat sorted by priority, but that shouldn't be
|
|
||||||
taken to mean that this is the order tasks will (or should) be completed in.
|
|
||||||
|
|
||||||
## In Progress
|
|
||||||
- [ ] [IN PROGRESS] Audio/Video
|
|
||||||
- [X] [DONE] encoding/streaming/decoding
|
|
||||||
- [X] [DONE] Call initiation
|
|
||||||
- [X] [DONE] Encryption
|
|
||||||
- [ ] [NEEDS TESTING] Video packet splitting.
|
|
||||||
- [ ] [IN PROGRESS] Auditing.
|
|
||||||
- [ ] [IN PROGRESS] Prevent audio skew (seems to be easily solvable client side.)
|
|
||||||
- [ ] [IN PROGRESS] Group chats, audio done.
|
|
||||||
- [ ] Networking:
|
|
||||||
- [ ] [NEEDS TESTING] UPnP port forwarding. ([#969](https://github.com/irungentoo/toxcore/pull/969))
|
|
||||||
- [ ] [TODO] NAT-PMP port forwarding.
|
|
||||||
- [ ] DHT:
|
|
||||||
- [ ] [ALMOST DONE] Metadata collection prevention. (docs/Prevent_Tracking.txt)
|
|
||||||
- [ ] [IN PROGRESS] Hardening against attacks.
|
|
||||||
- [ ] [IN PROGRESS] Optimizing the code.
|
|
||||||
- [ ] [DONE] Friend only group chats
|
|
||||||
- [X] [DONE] Networking base.
|
|
||||||
- [X] [MOSTLY DONE] Syncing chat state between clients (nicknames, list of who is in chat, etc...)
|
|
||||||
- [ ] [TODO] Group private messages. (and adding friends from group chats using those private messages.)
|
|
||||||
- [ ] [TODO] Group file transfers.
|
|
||||||
- [ ] [IN PROGRESS] Friends list syncing
|
|
||||||
- [ ] [IN PROGRESS] Make toxcore thread safe.
|
|
||||||
- [ ] [MOSTLY DONE] A way for people to connect to people on Tox if they are behind a bad NAT that blocks UDP (or is
|
|
||||||
just unpunchable) ([docs/TCP_Network.txt](TCP_Network.txt)) (Current way doesn't scale very well.)
|
|
||||||
|
|
||||||
## TODO
|
|
||||||
- [ ] [TODO] Make the core save/datafile portable across client versions/different processor architectures.
|
|
||||||
- [ ] [TODO] Friend_requests.c:
|
|
||||||
- [ ] [TODO] What happens when a friend request is received needs to be changed.
|
|
||||||
- [ ] [DONE?] Add multiple nospam functionality. ([#1317](https://github.com/irungentoo/toxcore/pull/1317))
|
|
||||||
|
|
||||||
- [ ] [TODO] Offline messaging
|
|
||||||
- [ ] [TODO] Security audit from professionals
|
|
||||||
|
|
||||||
## Done
|
|
||||||
- [X] [DONE] File transfers
|
|
||||||
- [X] [DONE] IPV6 support
|
|
||||||
- [X] [DONE] Encrypted Saves. (see: toxencryptsave)
|
|
||||||
Loading…
Reference in New Issue
Block a user