From 9499728d190bd3158cb74484fbc35e50f027e9c8 Mon Sep 17 00:00:00 2001 From: nastyagrifon Date: Sat, 1 Jun 2024 23:13:40 +1000 Subject: [PATCH] Add initial RU translations --- docs/Build_Core_ru.md | 25 +++++++++++++ docs/Build_Linux_ru.md | 78 ++++++++++++++++++++++++++++++++++++++++ docs/Build_MacOS_ru.md | 67 ++++++++++++++++++++++++++++++++++ docs/Build_Windows_ru.md | 64 +++++++++++++++++++++++++++++++++ 4 files changed, 234 insertions(+) create mode 100644 docs/Build_Core_ru.md create mode 100644 docs/Build_Linux_ru.md create mode 100644 docs/Build_MacOS_ru.md create mode 100644 docs/Build_Windows_ru.md diff --git a/docs/Build_Core_ru.md b/docs/Build_Core_ru.md new file mode 100644 index 0000000..2373545 --- /dev/null +++ b/docs/Build_Core_ru.md @@ -0,0 +1,25 @@ +## Сборка nekoray_core и nekobox_core + +### Структура директорий + +``` + | nekoray + | go/cmd/* + | Xray-core + | sing-box-extra + | sing-box + | ...... +``` + +### Компиляция + +1. `bash libs/get_source.sh` (автоматически скачивать структуру директорий, автоматически checkout коммит) +2. `GOOS=windows GOARCH=amd64 bash libs/build_go.sh` + +Можно посмотреть доступные GOOS и GOARCH в `libs/build_go.sh`. + +Для неофициальной сборки не нужна компиляция `updater` `launcher` + +### sing-box метки + +Посмотреть точное название меток можно в `libs/build_go.sh`. \ No newline at end of file diff --git a/docs/Build_Linux_ru.md b/docs/Build_Linux_ru.md new file mode 100644 index 0000000..9d36dde --- /dev/null +++ b/docs/Build_Linux_ru.md @@ -0,0 +1,78 @@ +Компиляция Nekoray в Linux + +## git clone репозитория + +``` +git clone https://github.com/MatsuriDayo/nekoray.git --recursive +``` + +## Простой метод компиляции + +Зависимости： + +1. Зависимости C++ `protobuf yaml-cpp zxing-cpp` должны быть поддерживаемой версии и установлены в системе。 +2. Должны быть установлены `qtbase` `qtsvg` `qttools` `qtx11extras` +3. Должны быть установлены Qt версии `5.12.x` или `5.15.x` +4. ОС системы `x86-64-linux-gnu` + +```shell +mkdir build +cd build +cmake -GNinja .. +ninja +``` + +После компиляции будет собран исполняемый файл `nekoray` + +Распакуйте Release，замените `nekoray` на тот что скомпилировали, а `launcher` можно удалить。 + +## Сложный метод компиляции + +### Параметры CMake + +| Параметры CMake | Значение по умолчанию| Текущее значение | +|-------------------|----------------------|-----------------------| +| QT_VERSION_MAJOR | 5 | QT版本 | +| NKR_NO_EXTERNAL | | 不包含外部 C/C++ 依赖 (以下所有) | +| NKR_NO_YAML | | 不包含 yaml-cpp | +| NKR_NO_QHOTKEY | | 不包含 qhotkey | +| NKR_NO_ZXING | | 不包含 zxing | +| NKR_NO_GRPC | | 不包含 gRPC | +| NKR_NO_QUICKJS | | 不包含 quickjs | +| NKR_PACKAGE | | 编译 package 版本 (aur)| +| NKR_PACKAGE_MACOS | | 编译 macos 版本 | +| NKR_LIBS | ./libs/deps/built | 依赖搜索目录 | +| NKR_DISABLE_LIBS | | 禁用 NKR_LIBS | + +1. `NKR_LIBS` 的值会被追加到 `CMAKE_PREFIX_PATH` +2. `NKR_PACKAGE` 打开后，`NKR_LIBS` 的默认值为 `./libs/deps/package` ，具体依赖请看 `build_deps_all.sh` +3. `NKR_PACKAGE_MACOS` 或 `NKR_PACKAGE` 打开后，应用将使用 appdata 目录存放配置，自动更新等功能将被禁用。 + +### C++ 部分 + +当您的发行版没有上面几个 C++ 依赖包，或者版本不符合要求时，可以参考 `build_deps_all.sh` 编译脚本自行编译。 + +条件： 已安装 Qt `5.12.x` 或 `5.15.x` + +#### 编译安装 C/C++ 依赖 + +（这一步可能要挂梯） + +```shell +./libs/build_deps_all.sh +``` + +#### 编译本体 + +```shell +mkdir build +cd build +cmake -GNinja .. +ninja +``` + +编译完成后得到 `nekoray` + +### Go 部分编译 + +请看 [Build_Core.md](./Build_Core.md) diff --git a/docs/Build_MacOS_ru.md b/docs/Build_MacOS_ru.md new file mode 100644 index 0000000..9ac7c86 --- /dev/null +++ b/docs/Build_MacOS_ru.md @@ -0,0 +1,67 @@ +提示：编译通过不代表所有功能可用，Tun 系统代理 这种功能大概率是不可用的。如果您懂得修复，我们欢迎您的 Pull Request。 + +Tip: Passing the compilation does not mean that all functions are available, and the function of Tun system proxy is probably not available. If you know how to fix it, we welcome your Pull Request. + +## git clone 源码 + +``` +git clone https://github.com/MatsuriDayo/nekoray.git --recursive +``` + +## 先决条件 + +1. 安装 `CMake` `Ninja` `npm` +2. 安装 Qt `5.15.x` 编译环境，并设置好有关环境变量，以免 CMake 找不到 Qt。 (`qtbase` `qtsvg` `qttools`) +3. 安装 `appdmg` (`sudo npm install -g appdmg`) + +## CMake 参数 + +同 Build_Linux + +## C++ 部分 + +### 编译安装 C/C++ 依赖 + +（这一步可能要挂梯） + +```shell +./libs/build_deps_all.sh +``` + +### 编译本体 + +```shell +mkdir build +cd build +cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DNKR_PACKAGE_MACOS=1 .. +ninja +``` + +### Go 部分编译 + +请看 [Build_Core.md](./Build_Core.md) + +## 打包 + +如有疑问，请参考[这个脚本](https://github.com/MatsuriDayo/nekoray/blob/main/libs/deploy_macos.sh) + +### 准备core + +将 编译得到的 `nekoray_core` `nekobox_core` 放入 `build/nekoray.app/Contents/MacOS` + +### 准备geo文件（可选） + +```shell +curl -Lso build/nekoray.app/Contents/MacOS/geoip.dat "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" +curl -Lso build/nekoray.app/Contents/MacOS/geosite.dat "https://github.com/v2fly/domain-list-community/releases/latest/download/dlc.dat" +curl -Lso build/nekoray.app/Contents/MacOS/geoip.db "https://github.com/SagerNet/sing-geoip/releases/latest/download/geoip.db" +curl -Lso build/nekoray.app/Contents/MacOS/geosite.db "https://github.com/SagerNet/sing-geosite/releases/latest/download/geosite.db" +``` + +如果打包时没有包含geo文件，可在应用内设置 `v2ray资源路径` 代替。 + +### 在nekoray目录下打包 + +```shell +appdmg appdmg.json /path/to/nekoray.dmg +``` diff --git a/docs/Build_Windows_ru.md b/docs/Build_Windows_ru.md new file mode 100644 index 0000000..a8a7728 --- /dev/null +++ b/docs/Build_Windows_ru.md @@ -0,0 +1,64 @@ +在 Windows 下编译 Nekoray + +### git clone 源码 + +``` +git clone https://github.com/MatsuriDayo/nekoray.git --recursive +``` + +### 安装 Visual Studio + +从微软官网安装，可以使用 2019 和 2022 版本，安装 Win32 C++ 开发环境。 + +安装好后可以在「开始」菜单找到 `x64 Native Tools Command Prompt` + +本文之后的命令均在该 cmd 内执行。`cmake` `ninja` 等工具使用 VS 自带的即可。 + +### 下载 Qt SDK + +目前 Windows Release 使用的版本是 Qt 6.5.x + +下载解压后，将 bin 目录添加到环境变量。 + +#### Release 编译用到的 Qt 包下载 (MSVC2019 x86_64) + +https://github.com/MatsuriDayo/nekoray_qt_runtime/releases/download/20220503/Qt6.5.0-Windows-x86_64-VS2022-17.5.5-20230507.7z + +#### 官方签名版 Qt 5.15.2 （可选，已知有内存泄漏的BUG） + +在此下载 `qtbase` `qtsvg` `qttools` 的包并解压到同一个目录。 + +https://download.qt.io/online/qtsdkrepository/windows_x86/desktop/qt5_5152/qt.qt5.5152.win64_msvc2019_64/ + +### C++ 部分编译 + +#### 编译安装 C/C++ 依赖 + +（这一步可能要挂梯） + +```shell +bash ./libs/build_deps_all.sh +``` + +目前只有 bash 脚本，没有批处理或 powershell，如果 Windows 没有带 bash 建议自行安装。 + +CMake 参数等细节与 Linux 大同小异，有问题可以参照 Build_Linux 文档。 + +#### 编译本体 + +请根据你的 QT Sdk 的位置替换命令 + +```shell +mkdir build +cd build +cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=D:/path/to/qt/5.15.2/msvc2019_64 .. +ninja +``` + +编译完成后得到 `nekoray.exe` + +最后运行 `windeployqt nekoray.exe` 自动复制所需 DLL 等文件到当前目录 + +### Go 部分编译 + +请看 [Build_Core.md](./Build_Core.md)