diff options
Diffstat (limited to 'docs/start_guide.rst')
-rw-r--r-- | docs/start_guide.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/start_guide.rst b/docs/start_guide.rst new file mode 100644 index 00000000..19ef982e --- /dev/null +++ b/docs/start_guide.rst | |||
@@ -0,0 +1,63 @@ | |||
1 | Using Tox | ||
2 | ========= | ||
3 | |||
4 | .. note:: There is a German version of this page available: :doc:`start_guide.de` | ||
5 | |||
6 | |||
7 | 1. :doc:`Build Tox <install>` | ||
8 | 2. Fix errors | ||
9 | 3. Consult IRC for help | ||
10 | 4. Go on debugging journey for devs | ||
11 | 5. Build Tox for real | ||
12 | 6. ??? | ||
13 | |||
14 | For all the work we've put into Tox so far, there isn't yet a decent | ||
15 | guide for how you *use* Tox. Here's a user-friendly attempt at it. | ||
16 | |||
17 | 1. Connect to the network! | ||
18 | |||
19 | - You need to connect to a bootstrapping server, to give you a | ||
20 | public key. | ||
21 | - Where can I find a public server? Right here, as of now: (the help | ||
22 | message from running ``nTox`` with no args will help) | ||
23 | |||
24 | - ``198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854`` | ||
25 | - ``192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858`` | ||
26 | - ``66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D`` | ||
27 | - ``192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143`` | ||
28 | |||
29 | 2. Find a friend! | ||
30 | |||
31 | - Now that you're on the network, you need a friend. To get one of | ||
32 | those, you need to to send or receive a request. What's a request, | ||
33 | you ask? It's like a friend request, but we use really scary and | ||
34 | cryptic numbers instead of names. When ``nTox`` starts, it shows | ||
35 | *your* long, scary number, called your *public key*. Give that to | ||
36 | people, and they can add you as a "friend". Or, you can add | ||
37 | someone else, with the ``/f`` command, if you like. | ||
38 | |||
39 | 3. Chat it up! | ||
40 | |||
41 | - Now use the ``/m`` command to send a message to someone. Wow, | ||
42 | you're chatting! | ||
43 | |||
44 | 4. But something broke! | ||
45 | |||
46 | - Yeah, pre-alpha-alpha software tends to do that. We're working on | ||
47 | it. | ||
48 | - Please report all crashes to either the GitHub page, or | ||
49 | ``#tox-dev`` on freenode. | ||
50 | |||
51 | 5. Nothing broke, but what does ``/f`` mean? | ||
52 | |||
53 | - ``nTox`` parses text as a command if the first character is a | ||
54 | forward-slash (``/``). You can check all commands in commands.md. | ||
55 | |||
56 | 6. Use and support Tox! | ||
57 | |||
58 | - Code for us, debug for us, document for us, translate for us, even | ||
59 | just talk about us! | ||
60 | - The more interest we get, the more work gets done, the better Tox | ||
61 | is. | ||
62 | |||
63 | |||