Browse Source

Merge pull request #1 from stargrave/master

Fix various typos and grammar mistakes
pull/2/head
orignal 7 years ago committed by GitHub
parent
commit
4d1ba675c1
  1. 12
      docs/build_notes_android.md
  2. 8
      docs/family.md
  3. 2
      docs/usage.md

12
docs/build_notes_android.md

@ -10,20 +10,20 @@
- [SDK](https://developer.android.com/studio/index.html) (выбрать command line tools only) - [SDK](https://developer.android.com/studio/index.html) (выбрать command line tools only)
- [NDK](https://developer.android.com/ndk/downloads/index.html) - [NDK](https://developer.android.com/ndk/downloads/index.html)
- [QT](https://www.qt.io/download-open-source/)(только для QT). Выбрать версию для андороида для вашей платформы. Например QT 5.6 под лиункс будет [этот файл](http://download.qt.io/official_releases/qt/5.6/5.6.1-1/qt-opensource-linux-x64-android-5.6.1-1.run ) - [QT](https://www.qt.io/download-open-source/)(только для QT). Выбрать версию для андроида для вашей платформы. Например QT 5.6 под линукс будет [этот файл](http://download.qt.io/official_releases/qt/5.6/5.6.1-1/qt-opensource-linux-x64-android-5.6.1-1.run )
Также потребуется Java JDK и Ant. Также потребуется Java JDK и Ant.
QT-Creator (только для QT) QT-Creator (только для QT)
------------------------ ------------------------
Запустить QT-creator, который должен быть установлен вместе с QT. Запустить QT-creator, который должен быть установлен вместе с QT.
Идти в Settings/Anndroid и указать пути к SDK and NDK. Идти в Settings/Android и указать пути к SDK and NDK.
Если все сделано правильно то должно появиться: Если все сделано правильно то должно появиться:
Android for armeabi-v7a (gcc, qt) и Android for x86 (gcc, qt). Android for armeabi-v7a (gcc, qt) и Android for x86 (gcc, qt).
Библиотеки Библиотеки
---------- ----------
Следущие собранные библиотеки следует взять и репозитария PurpleI2P. Следующие собранные библиотеки следует взять и репозитария PurpleI2P.
```bash ```bash
git clone https://github.com/PurpleI2P/Boost-for-Android-Prebuilt.git git clone https://github.com/PurpleI2P/Boost-for-Android-Prebuilt.git
git clone https://github.com/PurpleI2P/OpenSSL-for-Android-Prebuilt.git git clone https://github.com/PurpleI2P/OpenSSL-for-Android-Prebuilt.git
@ -42,14 +42,14 @@ git clone https://github.com/PurpleI2P/android-ifaddrs.git
Сборка без QT Сборка без QT
------------- -------------
- Поменять строку I2PD_LIBS_PATH в android/jni/Application.mk на директорию с зависимостями - Поменять строку I2PD_LIBS_PATH в android/jni/Application.mk на директорию с зависимостями
- Запустить команду 'ndk-build -j4' из директории andorid - Запустить команду 'ndk-build -j4' из директории android
- Поправить файл 'local.properties'. Строчки 'sdk.dir=<путь к SDK>' и 'ndk.dir=<путь к NDK>' - Поправить файл 'local.properties'. Строчки 'sdk.dir=<путь к SDK>' и 'ndk.dir=<путь к NDK>'
- Run 'ant clean debug' - Run 'ant clean debug'
Релизный .apk Релизный .apk
-------------- --------------
Релизный .apk следует подписать своей подписью для чего требуется Java keystore file(.jks). Либо взять уже существующий, либо сделать новый с помощью keytool либо сконвертировать какой нибудь из своих сертификатов. Например i2pd пидписан этим [сертификатом](https://github.com/PurpleI2P/i2pd/blob/openssl/contrib/certificates/router/orignal_at_mail.i2p.crt). Релизный .apk следует подписать своей подписью для чего требуется Java keystore file(.jks). Либо взять уже существующий, либо сделать новый с помощью keytool либо сконвертировать какой нибудь из своих сертификатов. Например i2pd подписан этим [сертификатом](https://github.com/PurpleI2P/i2pd/blob/openssl/contrib/certificates/router/orignal_at_mail.i2p.crt).
Создать файл 'ant.propeties' Создать файл 'ant.properties'
key.store='путь к keystore file' key.store='путь к keystore file'
key.alias='alias name' key.alias='alias name'
key.store.password='keystore password' key.store.password='keystore password'

8
docs/family.md

@ -2,13 +2,13 @@
================ ================
Your might want to specify a family, your router belongs to. 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 New family
----------- -----------
You must create family self-signed certificate and key. 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: Use the following list of commands:
openssl ecparam -name prime256v1 -genkey -out <your family name>.key openssl ecparam -name prime256v1 -genkey -out <your family name>.key
@ -20,8 +20,8 @@ Specify <your family name>.family.i2p.net for CN (Common Name) when requested.
Once you are done with it place <your-family-name>.key and <your-family-name>.crt to <ip2d data>/family folder (for exmple ~/.i2pd/family). Once you are done with it place <your-family-name>.key and <your-family-name>.crt to <ip2d data>/family folder (for exmple ~/.i2pd/family).
You should provide these two files to other members joining your 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. 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. Dont place .key file, it must be shared between you family members only. 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 How to join existing family
--------------------------- ---------------------------

2
docs/usage.md

@ -108,7 +108,7 @@ i2pd может быть использован для:
### Подключение к анонимному IRC серверу ### Подключение к анонимному IRC серверу
Чтобы подключиться к IRC серверу по адресу *walker.i2p*, добавьте следущее в ~/.i2pd/tunnels.conf: Чтобы подключиться к IRC серверу по адресу *walker.i2p*, добавьте следующее в ~/.i2pd/tunnels.conf:
[IRC2] [IRC2]
type = client type = client

Loading…
Cancel
Save