diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/commands.md | 25 | ||||
-rw-r--r-- | docs/using_tox.md | 38 |
2 files changed, 63 insertions, 0 deletions
diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 00000000..8669bb9b --- /dev/null +++ b/docs/commands.md | |||
@@ -0,0 +1,25 @@ | |||
1 | # Tox User Commands | ||
2 | Here's a list of commands that nTox accepts, | ||
3 | which can all be used by starting your line with | ||
4 | a */*. Currently there can be no spaces before this. | ||
5 | |||
6 | * */f* [ID] | ||
7 | + Add a friend with ID [ID]. | ||
8 | * */d* | ||
9 | + Call doMessenger() which does...something? | ||
10 | * */m* \[FRIEND\_NUM\] \[MESSAGE\] | ||
11 | + Message \[FRIEND\_NUM\] \[MESSAGE\]. | ||
12 | * */n* \[NAME\] | ||
13 | + Change your username to \[NAME\]. | ||
14 | * */l* | ||
15 | + Print your list of friends. (like you have any) | ||
16 | * */s* \[STATUS\] | ||
17 | + Set your status to \[STATUS\]. | ||
18 | * */a* \[ID\] | ||
19 | + Accept friend request from \[ID\]. | ||
20 | * */i* | ||
21 | + Print useful info about your client. | ||
22 | * */h* | ||
23 | + Print some help. | ||
24 | * */q/* | ||
25 | + Quit Tox. (why ;_;) | ||
diff --git a/docs/using_tox.md b/docs/using_tox.md new file mode 100644 index 00000000..b4f4310d --- /dev/null +++ b/docs/using_tox.md | |||
@@ -0,0 +1,38 @@ | |||
1 | # Using Tox | ||
2 | 1. Build Tox | ||
3 | 2. Fix errors | ||
4 | 3. Consult IRC for help | ||
5 | 4. Go on debugging journy for devs | ||
6 | 5. Build Tox for real | ||
7 | 6. ??? | ||
8 | |||
9 | For all the work we've put into Tox so far, | ||
10 | there isn't yet a decent guide for how you _use_ | ||
11 | Tox. Here's a user-friendly attempt at it. | ||
12 | |||
13 | 1. Connect to the network! | ||
14 | + You need to connect to a bootstrapping server, to give you a public key. | ||
15 | + Where can I find a public server? Right here, as of now: | ||
16 | (the help message from running nTox with no args will help) | ||
17 | + 198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854 | ||
18 | + 192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858 | ||
19 | + 66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D | ||
20 | + 192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143 | ||
21 | 2. Find a friend! | ||
22 | + Now that you're on the network, you need a friend. To get one of those, | ||
23 | you need to to send or receive a request. What's a request, you ask? | ||
24 | It's like a friend request, but we use really scary and cryptic numbers | ||
25 | instead of names. When nTox starts, it shows your _your_ long, scary number, | ||
26 | called your *public key*. Give that to people, and they can add you as | ||
27 | as "friend". Or, you can add someone else, with the */f* command, if you like. | ||
28 | 3. Chat it up! | ||
29 | + Now use the */m* command to send a message to someone. Wow, you're chatting! | ||
30 | 4. But something broke! | ||
31 | + Yeah, pre-alpha-alpha software tends to do that. We're working on it. | ||
32 | + Please report all crashes to either the github page, or #tox-dev on freenode. | ||
33 | 5. Nothing broke, but what does */f* mean? | ||
34 | + nTox parses text as a command if the first character is a forward-slash ('/'). | ||
35 | You can check all commands in commands.md. | ||
36 | 6. Use and support Tox! | ||
37 | + Code for us, debug for us, document for us, translate for us, even just talk about us! | ||
38 | + The more interest we get, the more work gets done, the better Tox is. | ||