From c7b8d9184b6d4cfda7e6e4a49739720de594ff39 Mon Sep 17 00:00:00 2001 From: Florian Hahn Date: Thu, 1 Aug 2013 21:46:48 +0200 Subject: add reSt versions of start_guide and start_guide.de --- docs/start_guide.rst | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/start_guide.rst (limited to 'docs/start_guide.rst') diff --git a/docs/start_guide.rst b/docs/start_guide.rst new file mode 100644 index 00000000..2b60bf42 --- /dev/null +++ b/docs/start_guide.rst @@ -0,0 +1,63 @@ +Using Tox +========= + +.. note:: There is a German version of this page available: :doc:`start_guide.de` + + +1. `Build Tox <../INSTALL.md>`_ +2. Fix errors +3. Consult IRC for help +4. Go on debugging journey for devs +5. Build Tox for real +6. ??? + +For all the work we've put into Tox so far, there isn't yet a decent +guide for how you *use* Tox. Here's a user-friendly attempt at it. + +1. Connect to the network! + + - You need to connect to a bootstrapping server, to give you a + public key. + - Where can I find a public server? Right here, as of now: (the help + message from running ``nTox`` with no args will help) + + - ``198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854`` + - ``192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858`` + - ``66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D`` + - ``192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143`` + +2. Find a friend! + + - Now that you're on the network, you need a friend. To get one of + those, you need to to send or receive a request. What's a request, + you ask? It's like a friend request, but we use really scary and + cryptic numbers instead of names. When ``nTox`` starts, it shows + *your* long, scary number, called your *public key*. Give that to + people, and they can add you as a "friend". Or, you can add + someone else, with the ``/f`` command, if you like. + +3. Chat it up! + + - Now use the ``/m`` command to send a message to someone. Wow, + you're chatting! + +4. But something broke! + + - Yeah, pre-alpha-alpha software tends to do that. We're working on + it. + - Please report all crashes to either the GitHub page, or + ``#tox-dev`` on freenode. + +5. Nothing broke, but what does ``/f`` mean? + + - ``nTox`` parses text as a command if the first character is a + forward-slash (``/``). You can check all commands in commands.md. + +6. Use and support Tox! + + - Code for us, debug for us, document for us, translate for us, even + just talk about us! + - The more interest we get, the more work gets done, the better Tox + is. + + -- cgit v1.2.3 From 1fb96df0878f6632f4c7626b742815b419997500 Mon Sep 17 00:00:00 2001 From: Florian Hahn Date: Thu, 1 Aug 2013 22:13:46 +0200 Subject: Update link to install documentation --- docs/start_guide.de.rst | 4 +--- docs/start_guide.rst | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) (limited to 'docs/start_guide.rst') diff --git a/docs/start_guide.de.rst b/docs/start_guide.de.rst index b997e575..4ebe7dc6 100644 --- a/docs/start_guide.de.rst +++ b/docs/start_guide.de.rst @@ -1,7 +1,7 @@ Tox nutzen ========== -1. Tox erstellen +1. :doc:`Tox erstellen ` 2. Fehler korrigieren 3. Im IRC nach Hilfe fragen 4. Auf Debug-Reise für Entwickler @@ -64,5 +64,3 @@ anwenderfreundlicher Versuch. sprich einfach über uns! - Je mehr Interesse wir erhalten, desto mehr Arbeit wird getan und desto besser wird Tox. - - diff --git a/docs/start_guide.rst b/docs/start_guide.rst index 2b60bf42..19ef982e 100644 --- a/docs/start_guide.rst +++ b/docs/start_guide.rst @@ -4,7 +4,7 @@ Using Tox .. note:: There is a German version of this page available: :doc:`start_guide.de` -1. `Build Tox <../INSTALL.md>`_ +1. :doc:`Build Tox ` 2. Fix errors 3. Consult IRC for help 4. Go on debugging journey for devs -- cgit v1.2.3