From db700a252bd6ca15e66b11a36dd476f8dd397bcb Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Wed, 9 Aug 2017 22:49:53 +0300 Subject: [PATCH] Fix various typos and grammar mistakes --- docs/about/contributing.md | 2 +- docs/devs/building/android.md | 16 ++++++++-------- docs/devs/building/unix.md | 2 +- docs/devs/hacking.md | 6 +++--- docs/tutorials/floodfill-bootstrap.md | 2 +- docs/tutorials/http.md | 2 +- docs/user-guide/FAQ.md | 6 +++--- docs/user-guide/family.md | 8 ++++---- docs/user-guide/run.md | 2 +- 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/about/contributing.md b/docs/about/contributing.md index cf4bf00..e663b4f 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -9,4 +9,4 @@ Coding guideline 3. Don't reinvent a wheel. Try to find appropriate solution in std or boost. If a feature is presented in both, use std. 4. Don't bring any additional dependency without discussion. However boost, openssl and zlib can be used in any amount. 5. No requirements for formatting or coding style. You can do whatever you like. -6. When you work with binary data, mind endianess. Use functions from I2PEndian.h +6. When you work with binary data, mind endianness. Use functions from I2PEndian.h diff --git a/docs/devs/building/android.md b/docs/devs/building/android.md index 3e9ab08..770c3e6 100644 --- a/docs/devs/building/android.md +++ b/docs/devs/building/android.md @@ -3,7 +3,7 @@ Building on Android There are two versions: with QT and without QT. -Pre-requesties +Pre-requisites -------------- You need to install Android SDK, NDK and QT with android support. @@ -19,8 +19,8 @@ QT-Creator (for QT only) ------------------------ Open QT-creator that should be installed with QT. -Go to Settings/Anndroid and specify correct paths to SDK and NDK. -If everything is correct you will see two set avaiable: +Go to Settings/Android and specify correct paths to SDK and NDK. +If everything is correct you will see two set available: Android for armeabi-v7a (gcc, qt) and Android for x86 (gcc, qt). Dependencies @@ -37,25 +37,25 @@ Building the app with QT ------------------------ - Open `qt/i2pd_qt/i2pd_qt.pro` in the QT-creator -- Change line `MAIN_PATH = /path/to/libraries` to an actual path where you put the dependancies to +- Change line `MAIN_PATH = /path/to/libraries` to an actual path where you put the dependencies to - Select appropriate project (usually armeabi-v7a) and build - You will find an .apk file in `android-build/bin` folder Building the app without QT --------------------------- -- Change line `I2PD_LIBS_PATH` in `android/jni/Application.mk` to an actual path where you put the dependancies to -- Run `ndk-build -j4` from andorid folder +- Change line `I2PD_LIBS_PATH` in `android/jni/Application.mk` to an actual path where you put the dependencies to +- Run `ndk-build -j4` from android folder - Create or edit file 'local.properties'. Place 'sdk.dir=' and 'ndk.dir=' - Run `ant clean debug` Creating release .apk ---------------------- -In order to create release .apk you must obtain a Java keystore file(.jks). Either you have in already, or you can generate it yourself using keytool, or from one of you existing well-know ceritificates. +In order to create release .apk you must obtain a Java keystore file(.jks). Either you have in already, or you can generate it yourself using keytool, or from one of you existing well-know certificates. For example, i2pd release are signed with this [certificate](https://github.com/PurpleI2P/i2pd/blob/openssl/contrib/certificates/router/orignal_at_mail.i2p.crt). -Create file 'ant.propeties': +Create file 'ant.properties': key.store='path to keystore file' key.alias='alias name' diff --git a/docs/devs/building/unix.md b/docs/devs/building/unix.md index c25e7c9..6b13822 100644 --- a/docs/devs/building/unix.md +++ b/docs/devs/building/unix.md @@ -27,7 +27,7 @@ Generic build process looks like this (with cmake): cd i2pd/ make -After successfull build i2pd could be installed with: +After successful build i2pd could be installed with: make install diff --git a/docs/devs/hacking.md b/docs/devs/hacking.md index 163575f..d36c953 100644 --- a/docs/devs/hacking.md +++ b/docs/devs/hacking.md @@ -14,11 +14,11 @@ This guide assumes: Notes on multithreading -* every compontent runs in its own thread +* every component runs in its own thread * each component (usually) has a public function `GetService()` which can be used to obtain the `boost::asio::io_service` that it uses. -* when talking between components/threads, **always** use `GetService().post()` and be mindfull of stack allocated memory. +* when talking between components/threads, **always** use `GetService().post()` and be mindful of stack allocated memory. ### NetDb @@ -83,7 +83,7 @@ If you use streaming please consider running all code within the destination thr #### Garlic.h -Provides Inter-Destination routing primatives. +Provides Inter-Destination routing primitives. ##### i2p::garlic::GarlicDestination diff --git a/docs/tutorials/floodfill-bootstrap.md b/docs/tutorials/floodfill-bootstrap.md index 2e126c2..2ddfd7c 100644 --- a/docs/tutorials/floodfill-bootstrap.md +++ b/docs/tutorials/floodfill-bootstrap.md @@ -10,7 +10,7 @@ I2PD has a unique feature that allows it to bootstrap off of any i2p router that * obtain a `router.info` file of a floodfill router out of band, save to `/tmp/floodfill.router.info` or some other path * run `i2pd --reseed.floodfill=/tmp/floodfill.router.info` and if that router is online you'll be able to bootstrap into the network from just that routers -## Caviets +## Caveats * The floodfill *must* be trustworthy, it could give you all colluding peers if it's a baddie. * *DO NOT* use a random floodfill unless you don't care about high security and just want to test out this feature. diff --git a/docs/tutorials/http.md b/docs/tutorials/http.md index d841e46..dec9cf5 100644 --- a/docs/tutorials/http.md +++ b/docs/tutorials/http.md @@ -37,4 +37,4 @@ If you wish to run your own website in Invisible Internet, follow those steps: Website is now available in Invisible Internet by visiting this address. -5) (Optional) Register short and rememberable .i2p domain on [inr.i2p](http://inr.i2p). +5) (Optional) Register short and memorable .i2p domain on [inr.i2p](http://inr.i2p). diff --git a/docs/user-guide/FAQ.md b/docs/user-guide/FAQ.md index 9d51c8f..69effb5 100644 --- a/docs/user-guide/FAQ.md +++ b/docs/user-guide/FAQ.md @@ -44,7 +44,7 @@ I2P router to discover and fix that issue. First of all, synchronize system clock on your machine with Internet. If that does not help, on Linux machines, check the number of open file descriptors -allowed to a proccess. Run: +allowed to a process. Run: ulimit -n @@ -72,7 +72,7 @@ Run i2pd for a long time, download and seed some popular torrents. ## What browser should I use to browse I2P websites? -Use any opensource browser - for example, Firefox or Chromium based. Create separate profile for I2P ([firefox instructions](https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles)), try not to mix clearnet browsing with I2P. Learn how to configure your browser for better privacy and security. +Use any open source browser - for example, Firefox or Chromium based. Create separate profile for I2P ([firefox instructions](https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles)), try not to mix clearnet browsing with I2P. Learn how to configure your browser for better privacy and security. Good idea is to configure [privoxy](https://wiki.archlinux.org/index.php/Privoxy) for I2P/onion/clearnet browsing at the same time. @@ -91,7 +91,7 @@ I2P and Tor has some similarities, but they are completely different in every wa Tor is designed to act as anonymous proxy for the regular Internet, I2P is designed to create anonymous network layer with its own private resources. -Tor Project was started by US military and has a long history of recieving funds +Tor Project was started by US military and has a long history of receiving funds from the government, while I2P was started by community of independent civilians. Tor is highly centralized by design, while I2P is decentralized and distributed. diff --git a/docs/user-guide/family.md b/docs/user-guide/family.md index bb92517..c1e1242 100644 --- a/docs/user-guide/family.md +++ b/docs/user-guide/family.md @@ -2,13 +2,13 @@ Family configuration ==================== Your might want to specify a family, your router belongs to. -There are two possibilities: create new family or joing to existing. +There are two possibilities: create new family or joining to existing. New family ----------- You must create family self-signed certificate and key. -The only key type supposted is prime256v1. +The only key type supported is prime256v1. Use the following list of commands: openssl ecparam -name prime256v1 -genkey -out .key @@ -20,8 +20,8 @@ Specify .family.i2p.net for CN (Common Name) when requested. Once you are done with it place .key and .crt to /family folder (for exmple ~/.i2pd/family). You should provide these two files to other members joining your family. -If you want to register you family and let I2P network recorgnize it, create pull request for you .crt file into contrib/certificate/family. -It will appear in i2pd and I2P next releases packages. Dont place .key file, it must be shared between you family members only. +If you want to register you family and let I2P network recognize it, create pull request for you .crt file into contrib/certificate/family. +It will appear in i2pd and I2P next releases packages. Don't place .key file, it must be shared between you family members only. How to join existing family --------------------------- diff --git a/docs/user-guide/run.md b/docs/user-guide/run.md index d06d74c..27439c3 100644 --- a/docs/user-guide/run.md +++ b/docs/user-guide/run.md @@ -27,7 +27,7 @@ i2pd supports the following signals: ### systemd unit -Some Linux packages have a systemd control unit, so it is possible to managage i2pd with it. +Some Linux packages have a systemd control unit, so it is possible to manage i2pd with it. Start/stop i2pd: