Merge pull request #146

6af88ab Documentation: fix repeated step number in 828314e (anonimal)
828314e Documentation: cleanup before Satoshi Roundtable. (anonimal)

README.md

@@ -1,33 +1,33 @@
 # **ˈKɔːvrɪ**
 
-1. To cover, veil, wrap *[(Esperanto)](https://en.wikipedia.org/wiki/Esperanto)*
-2. The secure, private, untraceable C++ implementation of the [I2P](https://geti2p.net) anonymous network,
+1. To cover, veil, wrap *[(Esperanto)](https://en.wikipedia.org/wiki/Esperanto)*.
+2. The secure, private, untraceable C++ implementation of the [I2P](https://geti2p.net) anonymous network.
 
 [![Build Status](https://travis-ci.org/monero-project/kovri.svg?branch=master)](https://travis-ci.org/monero-project/kovri)
 [![Documentation](https://codedocs.xyz/monero-project/kovri.svg)](https://codedocs.xyz/monero-project/kovri/)
 
 ## Disclaimer
-- Currently pre-alpha software; under heavy development!
-- Use branch ```master``` for more stability.
+- Currently pre-alpha software; under heavy development.
+- Use branch ```master``` for most stability.
 - See branch ```development``` for most recent activity.
 
 ## Quickstart
 1. Read [BUILDING.md](https://github.com/monero-project/kovri/blob/master/doc/BUILDING.md) and build instructions and minimum version requirements
 1. Choose a port between ```9111``` and ```30777```.
-2. Open your chosen port in your NAT/Firewall to allow incoming TCP/UDP connections (or optional UPnP, see [BUILDING.md](https://github.com/monero-project/kovri/blob/master/doc/BUILDING.md))
+2. Open your NAT/Firewall to allow incoming TCP/UDP connections to your chosen port (UPnP optional; see [BUILDING.md](https://github.com/monero-project/kovri/blob/master/doc/BUILDING.md))
 3. Clone, build, and run Kovri:
 ```bash
 $ git clone https://github.com/monero-project/kovri
 $ cd kovri/build && cmake ../ && make
 $ ./kovri -p [your chosen port number]
 ```
 
-## Developers
-- See [CONTRIBUTING.md](https://github.com/monero-project/kovri/blob/master/doc/CONTRIBUTING.md) before sending PR.
-
 ## Documentation
 - See [FAQ.md](https://github.com/monero-project/kovri/blob/master/doc/FAQ.md) or join us in ```#kovri``` or ```#kovri-dev``` on Freenode or Irc2P.
-- All other documentation is on our ./doc directory
+- All other documentation is on our [doc](https://github.com/monero-project/kovri/tree/master/doc) directory
+
+## Developers
+- See [CONTRIBUTING.md](https://github.com/monero-project/kovri/blob/master/doc/CONTRIBUTING.md) before sending PR.
 
 ## Vulnerability Response
 - Please, submit a report via [HackerOne](https://hackerone.com/kovri)
@@ -39,7 +39,7 @@ Key fingerprint = 1218 6272 CD48 E253 9E2D  D29B 66A7 6ECF 9144 09F1
 Note: our future VRP will be inline with [I2P's VRP](https://trac.i2p2.de/ticket/1119).
 
 ## Acknowledgments
-- **orion** and **EinMByte** for providing ```i2pcpp```: the [original](http://git.repo.i2p.xyz/w/i2pcpp.git) C++ implementation of I2P.
-- **orignal** for providing ```i2pd```: an insecure and issue-ridden (but mostly-working) C++ implementation of I2P for [us to fork from](https://github.com/purplei2p/i2pd/commit/45d27f8ddc43e220a9eea42de41cb67d5627a7d3).
+- **orion** for providing ```i2pcpp```: the [original](http://git.repo.i2p.xyz/w/i2pcpp.git) C++ implementation of I2P.
+- **orignal** for providing ```i2pd```: an insecure/issue-ridden but mostly-working C++ implementation of I2P for [us to fork from](https://github.com/purplei2p/i2pd/commit/45d27f8ddc43e220a9eea42de41cb67d5627a7d3).
 - **EinMByte** for improving *both* implementations.
 - The ed25519/ folder is based on the [ref10 implementation from SUPERCOP](http://bench.cr.yp.to/supercop.html).

doc/BUILDING.md

@@ -1,4 +1,4 @@
-## 1. Satisfy minimum requirements
+## Step 1. Minimum requirements
 
 - [CMake](https://cmake.org/) 2.8.12
 - [Boost](http://www.boost.org/) 1.54
@@ -22,14 +22,14 @@ Optional
 ### Windows
 - [VS2013](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx) (last known to work with 12.0.21005.1)
 
-### Open your NAT/Firewall
+## Step 2. Open your NAT/Firewall
 1. Choose a port between ```9111``` and ```30777```.
 2. Poke a hole in your NAT/Firewall to allow incoming TCP/UDP connections to that port.
 3. Don't share this number with anyone as it will effect your anonymity!
 
 If you do not choose a port via cli or ```kovri.conf```, Kovri will randomly generate a new one on each startup. If you do not have access to your NAT, you can instead install and build with [MiniUPnP](http://miniupnp.free.fr/files/) support
 
-## 2. Install dependencies
+## Step 3. Install dependencies
 
 ### Debian (Jessie) / Ubuntu (Trusty, Vivid, Wily)
 ```bash
@@ -55,7 +55,7 @@ $ brew install cmake boost cryptopp openssl
 $ brew install miniupnpc doxygen  ## (optional)
 ```
 
-## 3. Building
+## Step 4. Build
 
 ### To view CMake options:
 ```bash
@@ -85,10 +85,10 @@ $ cmake -DWITH_TESTS=ON -DWITH_BENCHMARKS=ON ../ && make
 
 ### To produce Doxygen
 ```bash
-$ cmake -DWITH_DOXYGEN=ON ../ && make doc  # output will be in ./doc/Doxygen/
+$ cmake -DWITH_DOXYGEN=ON ../ && make doc  # output will be in kovri/doc/Doxygen/
 ```
 
-### Run Kovri!
+### Steap 5. Run Kovri!
 ```bash
 $ ./kovri -p [your chosen port]
 ```
@@ -102,7 +102,7 @@ For a full list of options:
 $ ./kovri -h
 ```
 
-## 4. Configuration files *(optional)*
+## Step 6. Configuration files *(optional)*
 
 Configuration files has INI-like syntax: <key> = <value>.
 All command-line parameters are allowed as keys, for example:

doc/FAQ.md

@@ -43,7 +43,7 @@ Ask yourself one question: do you trust your anonymity with i2pd's [attitude](ht
 ```
 Our answer? **...No, we don't!**
 
-## Why are there two i2pd repositories; one on Bitbucket and one on GitHub?
+## Why did you fork from i2pd and why are there two i2pd repositories; one on Bitbucket and one on GitHub?
 So begins the drama of i2pd.
 
 One of the developers with push privileges on GitHub pushed a commit(s) that orignal did not like. Instead of working together to resolve the issue, orignal took i2pd to Bitbucket, deleted all existing git history, and made himself sole 'contributor' of the software. He then vowed to never return to Irc2P.