summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDave Eddy <dave@daveeddy.com>2013-07-31 17:06:04 -0400
committerDave Eddy <dave@daveeddy.com>2013-07-31 17:15:32 -0400
commita784c852f44e57876a02fa1cffa961c55d94e5b3 (patch)
treed0683bf27cb727e96c2a1ab471ccea03a703fc90
parentc558cb63f6db35bd51f2f2331e21df03105ee82a (diff)
touch up docs to link to eachother
-rw-r--r--INSTALL.md23
-rw-r--r--README.md11
-rw-r--r--start_guide.md24
3 files changed, 40 insertions, 18 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 9efa7ee9..90563790 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,5 +1,17 @@
1#Install Instructions
2
3- [Installation](#installation)
4 - [Linux](#linux)
5 - [OS X](#osx)
6 - [Homebrew](#homebrew)
7 - [Non-Homebrew](#non-homebrew)
8 - [Windows](#windows)
9- [Usage](#usage)
10
11<a name="installation" />
1##Installation 12##Installation
2 13
14<a name="linux" />
3###Linux: 15###Linux:
4 16
5Build dependencies: 17Build dependencies:
@@ -40,8 +52,10 @@ Or you could just build everything that is supported on your platform by running
40make 52make
41``` 53```
42 54
43###OSX: 55<a name="osx" />
56###OS X:
44 57
58<a name="homebrew" />
45####Homebrew: 59####Homebrew:
46``` 60```
47brew install libtool automake autoconf libconfig libsodium 61brew install libtool automake autoconf libconfig libsodium
@@ -50,6 +64,7 @@ make
50sudo make install 64sudo make install
51``` 65```
52 66
67<a name="non-homebrew" />
53####Non-homebrew: 68####Non-homebrew:
54 69
55Much the same as Linux, remember to install the latest XCode and the developer tools (Preferences -> Downloads -> Command Line Tools). 70Much the same as Linux, remember to install the latest XCode and the developer tools (Preferences -> Downloads -> Command Line Tools).
@@ -69,6 +84,7 @@ Another thing you may want to install is the latest gcc, this caused me a few pr
69no longer includes gcc and instead uses LLVM-GCC, a nice install guide can be found at 84no longer includes gcc and instead uses LLVM-GCC, a nice install guide can be found at
70http://caiustheory.com/install-gcc-421-apple-build-56663-with-xcode-42 85http://caiustheory.com/install-gcc-421-apple-build-56663-with-xcode-42
71 86
87<a name="windows" />
72###Windows: 88###Windows:
73 89
74You should install: 90You should install:
@@ -100,3 +116,8 @@ Or you could just build everything that is supported on your platform by running
100```bash 116```bash
101mingw32-make 117mingw32-make
102``` 118```
119
120<a name="usage" />
121## Usage
122
123- [Start Guide](start_guide.md)
diff --git a/README.md b/README.md
index 499d8202..55135d03 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ Keep everything really simple.
28 28
29## Roadmap: 29## Roadmap:
30- [x] Get our DHT working perfectly. (Done, needs large scale testing though) 30- [x] Get our DHT working perfectly. (Done, needs large scale testing though)
31- [x] Reliable connection (See Lossless UDP protocol) to other peers according to client ID. (Done, see DHT_sendfiletest.c for an example) 31- [x] Reliable connection (See Lossless UDP protocol) to other peers according to client ID. (Done, see `DHT_sendfiletest.c` for an example)
32- [x] Encryption. (Done) 32- [x] Encryption. (Done)
33- [ ] Get a simple text only IM client working perfectly. (This is where we are) 33- [ ] Get a simple text only IM client working perfectly. (This is where we are)
34- [ ] Streaming media 34- [ ] Streaming media
@@ -45,7 +45,8 @@ configure for the normal user or suffer from being way too centralized.
45 45
46### Documentation: 46### Documentation:
47 47
48[DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br /> 48- [Installation](/INSTALL.md)
49[Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br /> 49- [DHT Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/DHT)<br />
50[Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br /> 50- [Lossless UDP Protocol](https://github.com/irungentoo/ProjectTox-Core/wiki/Lossless-UDP)<br />
51[Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas) 51- [Crypto](https://github.com/irungentoo/ProjectTox-Core/wiki/Crypto)<br />
52- [Ideas](https://github.com/irungentoo/ProjectTox-Core/wiki/Ideas)
diff --git a/start_guide.md b/start_guide.md
index b4f4310d..31d7ca8e 100644
--- a/start_guide.md
+++ b/start_guide.md
@@ -1,5 +1,5 @@
1# Using Tox 1# Using Tox
21. Build Tox 21. [Build Tox](/INSTALL.md)
32. Fix errors 32. Fix errors
43. Consult IRC for help 43. Consult IRC for help
54. Go on debugging journy for devs 54. Go on debugging journy for devs
@@ -13,25 +13,25 @@ Tox. Here's a user-friendly attempt at it.
131. Connect to the network! 131. Connect to the network!
14 + You need to connect to a bootstrapping server, to give you a public key. 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: 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) 16 (the help message from running `nTox` with no args will help)
17 + 198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854 17 + `198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854`
18 + 192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858 18 + `192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858`
19 + 66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D 19 + `66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D`
20 + 192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143 20 + `192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143`
212. Find a friend! 212. Find a friend!
22 + Now that you're on the network, you need a friend. To get one of those, 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? 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 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, 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 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. 27 as "friend". Or, you can add someone else, with the `/f` command, if you like.
283. Chat it up! 283. Chat it up!
29 + Now use the */m* command to send a message to someone. Wow, you're chatting! 29 + Now use the `/m` command to send a message to someone. Wow, you're chatting!
304. But something broke! 304. But something broke!
31 + Yeah, pre-alpha-alpha software tends to do that. We're working on it. 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. 32 + Please report all crashes to either the [github](/) page, or `#tox-dev` on freenode.
335. Nothing broke, but what does */f* mean? 335. Nothing broke, but what does `/f` mean?
34 + nTox parses text as a command if the first character is a forward-slash ('/'). 34 + `nTox` parses text as a command if the first character is a forward-slash (`/`).
35 You can check all commands in commands.md. 35 You can check all commands in commands.md.
366. Use and support Tox! 366. Use and support Tox!
37 + Code for us, debug for us, document for us, translate for us, even just talk about us! 37 + Code for us, debug for us, document for us, translate for us, even just talk about us!