From 435f89affa89f08ddf9f298695b891e80c84e3e7 Mon Sep 17 00:00:00 2001 From: AbolfazlHo <30938396+AbolfazlHo@users.noreply.github.com> Date: Sun, 23 Apr 2023 11:48:13 +0530 Subject: [PATCH] Update Persian documents (#520) * Build-macOs-fa added * persian documents fixed * Build_Core_fa.md added --- README_fa.md | 2 +- docs/Build_Core_fa.md | 83 ++++++++++++++++++++++++++++ docs/Build_MacOS_fa.md | 122 ++++++++++++++++++++++++++++++----------- 3 files changed, 174 insertions(+), 33 deletions(-) create mode 100644 docs/Build_Core_fa.md diff --git a/README_fa.md b/README_fa.md index 06bea0d..bb3e2b1 100644 --- a/README_fa.md +++ b/README_fa.md @@ -62,7 +62,7 @@ https://matsuridayo.github.io [Windows](docs/Build_Windows.md) -[macOs] (docs/Build_MacOS_fa) +[macOs](docs/Build_MacOS_fa.md) ## کمک مالی / Donate diff --git a/docs/Build_Core_fa.md b/docs/Build_Core_fa.md new file mode 100644 index 0000000..c88b1b9 --- /dev/null +++ b/docs/Build_Core_fa.md @@ -0,0 +1,83 @@ +## ساختن (بیلد) nekobox_core و nekoray_core + +###ساختن (بیلد) آسان + +۱. در Terminal به روت پروژه Nekoray در دستگاه خود بروید. + +اگر تا اینجا با مستندات پیش آمده باشید، کافی است دستور زیر را در Terminal وارد کنید و دکمه Return را بفشارید. +```shell +cd . +``` +
+ +۲. در همین مسیر`v2ray-core` را از [این](https://github.com/MatsuriDayo/v2ray-core) منبع دریافت کنید. + +برای این می توانید دستور زیر را در `Terminal` وارد کنید و دکمه `Return` را بفشارید. +```shell +git clone https://github.com/MatsuriDayo/v2ray-core.git +``` +
+ +۳. دستورهای زیر را به ترتیب در `Terminal` وارد کنید و دکمه `Return` را بفشارید. +```shell +cd go/cmd/nekoray_core +go build +``` +اگر پس از دستور دوم با خطای `zsh: command not found: go` رو به رو شدید به این معنی است که `go` روی دستگاه شما نصب نیست. برای نصب `go` دستور زیر را در `Terminal` وارد کنید و دکمه `Return` را بفشارید. +```shell +brew install go +``` +پس از نصب شدن `go` باز دستور `go build` را در `Terminal` اجرا کنید. + +در پایان این گام، فایل `nekoray_core` در مسیر زیر ساخته خواهد شد. + +`مسیر پروژه Nekoray/go/cmd/nekoray_core` + +
+ +۴. دستورهای زیر را به ترتیب در `Terminal` وارد کنید و دکمه `Return` را بفشارید. +```shell +cd .. +cd nekobox_core +go build +``` +در پایان این گام، فایل `nekobox_core` در مسیر زیر ساخته خواهد شد. + +
+ +- برای موارد خاص به`libs/get_source.sh`و `libs/build_go.sh` رجوع کنید. +- نیازی نیست این مراحل را برای پوشه `updater` انجام دهید. این سخن به این معنی است که نیازی نیست `launcher` را بسازید (بیلد بگیرید). + +
+ +### ساختن (بیلد) معمولی + + +۱. در Terminal به روت پروژه Nekoray در دستگاه خود بروید. + +اگر تا اینجا با مستندات پیش آمده باشید، کافی است دستور زیر را در Terminal وارد کنید و دکمه Return را بفشارید. +```shell +cd . +``` +
+ +۲. در همین مسیر`v2ray-core` را از [این](https://github.com/MatsuriDayo/v2ray-core) منبع دریافت کنید. + +برای این می توانید دستور زیر را در `Terminal` وارد کنید و دکمه `Return` را بفشارید. +```shell +git clone https://github.com/MatsuriDayo/v2ray-core.git +``` +
+ +۳. دستور زیر را در `Terminal`وارد کنید و دکمه `Return`را بفشارید. +```shell +GOOS=windows GOARCH=amd64 bash libs/build_go.sh +``` + +- برای دریافتن `GOOS` و `GOARCH` پشتیبانی شده به `libs/build_go.sh`مراجعه کنید. + +
+ +### تگ های sing-box + +بوای تگ های خاص به `libs/build_go.sh` رجوع کنید. \ No newline at end of file diff --git a/docs/Build_MacOS_fa.md b/docs/Build_MacOS_fa.md index 2c00265..c56efa0 100644 --- a/docs/Build_MacOS_fa.md +++ b/docs/Build_MacOS_fa.md @@ -1,80 +1,125 @@ # کامپایل کردن Nekoray در macOs ## پروژه Nekoray را از منبع آن دریافت کنید -در terminal در مسیر دلخواه خود، دستور زیر را وارد کنید و دکمه return را بفشارید. +در `Terminal` در مسیر دلخواه خود، دستور زیر را وارد کنید و دکمه `return` را بفشارید. ```shell git clone https://github.com/MatsuriDayo/nekoray.git --recursive ``` +اگر `git` روی دستگاه از پیش نصب نباشد، دستگاه، خودکار نصب آن را پیشنهاد می‌کند. مرحله‌های نصب را به انجام برسانید و سپس دوباره دستور پیش گفته را در `Terminal` اجرا کنید. + +سپس وارد پوشه `nekoray` شوید. +برای کامپایل کردن پروژه، پیش‌نیازهای زیر را نصب کنید. برای این، دستور زیر را در `Terminal` وارد کنید و دکمه `Return` را بفشارید. + + +```shell +cd nekoray +``` +
## پیش‌نیازها -برای کامپایل کردن پروژه، پیش‌نیازهای زیر را نصب کنید. -۱. `CMake` -برای نصب CMake دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +###۱. `CMake` + +برای نصب `CMake` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell brew install cmake ``` -اگر با خطای `zsh: command not found: brew` روبه‌رو شدید به این معنی است که `homebrew` در دستگاه شما نصب نیست. برای نصب آن نخست باید XCode's command line tools را نصب کنید. اگر به این مشکل برخورده‌اید، گام‌های ۱.۱، ۱.۲ و ۱.۳ را دنبال کنید. -۱.۱. نصب XCode's command line tools -دستور زیر را در terminal وادر کنید و دکمه return را بفشارید. +اگر با خطای `zsh: command not found: brew` روبه‌رو شدید به این معنی است که `homebrew` در دستگاه شما نصب نیست. برای نصب آن نخست باید `XCode's command line tools` را نصب کنید. اگر به این مشکل برخورده‌ اید، گام های `۱.۱`، `۱.۲` و `۱.۳` را دنبال کنید. + +
+ +####۱.۱. نصب `XCode's command line tools` + +دستور زیر را در `terminal` وادر کنید و دکمه `return` را بفشارید. ```shell xcode-select --install ``` -۱.۲. نصب homebrew -دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. + +
+ +####۱.۲. نصب `homebrew` + +دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell curl -fsSL -o install.sh https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh ``` -۱.۳. حال می‌توانید با دستوری که پیشتر گفتیم، CMake را نصب کنید. -۲. `Ninja` -برای نصب Ninja دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +
+ +####۱.۳. حال می‌توانید با دستوری که پیشتر گفتیم، `CMake` را نصب کنید. + +
+ +###۲. `Ninja` + +برای نصب `Ninja` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell sudo port install ninja ``` -اگر با خطای `sudo: port: command not found` روبه‌رو شدید، به این معنی است که MacPorts روی دستگاه شما نصب نیست. نسخه MacPorts متناسب با نسخه macOs خود را بارگری و نصب کنید. سپس بار دیگر، دستور نصب Ninja را در terminal وارد کرده و دکمه return را بفشارید. +اگر با خطای `sudo: port: command not found` روبه‌رو شدید، به این معنی است که `MacPorts` روی دستگاه شما نصب نیست. نسخه `MacPorts` متناسب با نسخه `macOs` خود را بارگری و نصب کنید. سپس بار دیگر، دستور نصب `Ninja` را در `terminal` وارد کرده و دکمه `return` را بفشارید. -۳. `npm` -بدای نصب npm دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +
+ +###۳. `npm` + +برای نصب `npm` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell -brew install node +brew install npm ``` -۴. `qtbase` -برای نصب qtbase دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +
+ +###۴. `qtbase` + +برای نصب `qtbase` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell sudo port install qt5-qtbase ``` -۵. `qtsvg` -برای نصب qtsvg دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +
+ +###۵. `qtsvg` + +برای نصب `qtsvg` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell sudo port install qt5-qtsvg ``` -۶. `qttools` -برای نصب qttools دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +
+ +###۶. `qttools` + +برای نصب `qttools` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell sudo port install qt5-qttools ``` -۷. `appdmg` -برای نصب appdmg دستور زیر را در terminal وارد کنید و دکمه return را بفشارید. +
+ +###۷. `appdmg` + +برای نصب `appdmg` دستور زیر را در `terminal` وارد کنید و دکمه `return` را بفشارید. ```shell sudo npm install -g appdmg ``` +
+ ## C++ ### وابستگی‌های C و ++C را کامپایل و نصب کنید. -دستور زیر را در terminal وارد کرده و دکمه return را بفشارید. + +دستور زیر را در `terminal` وارد کرده و دکمه `return` را بفشارید. ```shell ./libs/build_deps_all.sh ``` +
+ ### آنتولوژی را کامپایل کنید. -دستور زیر را در terminal وارد کرده و دکمه return را بفشارید. + +دستور زیر را در `terminal` وارد کرده و دکمه `return` را بفشارید. ```shell mkdir build cd build @@ -82,16 +127,26 @@ cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DNKR_PACKAGE_MACOS=1 .. ninja ``` -### هسته نرم‌افزار را کامپایل کنید. -چگونگی کامپایل کردن هسته نرم‌افزار را [اینجا ](./Build_Core.md)بخوانید. +
+ +## هسته نرم افزار + +### هسته نرم افزار را کامپایل کنید. + +چگونگی کامپایل کردن هسته نرم افزار را [اینجا ](./Build_Core_fa.md)بخوانید. + +
### جایگذاری هسته + فایل کامپایل شده `nekoray_core` و `nekobox_core` را در مسیر زیر کپی کنید. `build/nekoray.app/Contents/MacOS` +
-### فایل‌های جغرافی را تهیه کنید. (اختیاری) -اگر مایلید با اجرای دستورهای زیر در terminal فایل‌های جغدافی را تهیه کنید. +## فایل‌های جغرافی را تهیه کنید. (اختیاری) + +اگر مایلید، با اجرای دستورهای زیر در `Terminal` فایل های جغرافی را تهیه کنید. ```shell curl -Lso build/nekoray.app/Contents/MacOS/geoip.dat "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" @@ -99,7 +154,10 @@ curl -Lso build/nekoray.app/Contents/MacOS/geosite.dat "https://github.com/v2fly 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" ``` +
+ +## پایان کار + +فایل اجرایی `Nekoray` در مسیر زیر قرار دارد. می‌توانید آن را در مسیر دلخواه کپی کنید. -### پایان کار -فایل اجرایی Nekoray در مسیر زیر قرار دارد. می‌توانید آن را در مسیر دلخواه کپی کنید. `مسیر پروژه Nekoray/build` \ No newline at end of file