From 53f06aa80abb0b0c534b801f4805476dd801c0c7 Mon Sep 17 00:00:00 2001 From: xvzc Date: Fri, 30 Aug 2024 17:02:03 +0900 Subject: [PATCH] docs: update installation guide --- README.md | 2 +- _docs/BUILD.md | 11 ++++++++ _docs/{QUICK_START.md => INSTALL.md} | 42 +++++++++++++--------------- _docs/README_ja.md | 2 +- _docs/README_ko.md | 2 +- _docs/README_ru.md | 2 +- _docs/README_zh-cn.md | 2 +- 7 files changed, 36 insertions(+), 27 deletions(-) create mode 100644 _docs/BUILD.md rename _docs/{QUICK_START.md => INSTALL.md} (78%) diff --git a/README.md b/README.md index 93d85fe..0bbf445 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ A simple and fast software designed to bypass **Deep Packet Inspection**. ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # Usage ``` diff --git a/_docs/BUILD.md b/_docs/BUILD.md new file mode 100644 index 0000000..0335012 --- /dev/null +++ b/_docs/BUILD.md @@ -0,0 +1,11 @@ +# Building from Source +Although pre-built binaries are available for multiple platforms, you can also build your own binaries on your need. + +## Prerequisites +1. Ensure you've installed go version `1.21` +2. Clone this repository to a location of your choice. + +## Build +```bash +CGO_ENABLED=0 go build -ldflags="-w -s" ./cmd/... +``` diff --git a/_docs/QUICK_START.md b/_docs/INSTALL.md similarity index 78% rename from _docs/QUICK_START.md rename to _docs/INSTALL.md index e5262da..95ed5e0 100644 --- a/_docs/QUICK_START.md +++ b/_docs/INSTALL.md @@ -1,12 +1,18 @@ -# Quick Start +# Installation Guide + + * [Binary](#binary) + * [Go](#go) + * [Package Manager](#package-manager) + * [brew(MacOS)](#brew(MacOS)) + * [pkg(FreeBSD)](#pkg(freebsd)) + -## Binary +# Binary SpoofDPI will be installed in `~/.spoofdpi/bin`. To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` ```bash export PATH=$PATH:~/.spoofdpi/bin ``` ---- ```bash # macOS Intel curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 @@ -30,29 +36,21 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle ``` -## FreeBSD 😈 -``` -# Build from ports tree -make -C /usr/ports/net/spoofdpi install clean -# Install the package -pkg install spoofdpi -``` - -## Homebrew 🍻 -```bash -brew install spoofdpi -``` - -## Go -You can also install SpoofDPI with `go install`. +# Go ```bash go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest ``` -## How to build +# Package Manager +## brew(MacOS) ```bash -git clone https://github.com/xvzc/SpoofDPI.git -cd SpoofDPI -go build ./cmd/... +brew install spoofdpi ``` + +## pkg(FreeBSD) +```bash +pkg install spoofdpi +``` + + diff --git a/_docs/README_ja.md b/_docs/README_ja.md index 3129f8c..ff23872 100644 --- a/_docs/README_ja.md +++ b/_docs/README_ja.md @@ -9,7 +9,7 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # 使用方法 ``` diff --git a/_docs/README_ko.md b/_docs/README_ko.md index c6df6bd..161cab2 100644 --- a/_docs/README_ko.md +++ b/_docs/README_ko.md @@ -9,7 +9,7 @@ DPI(Deep Packet Inspection) 우회를 위해 고안된 소프트웨어 ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md)를 참고바랍니다. +SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md)를 참고바랍니다. # 사용법 ``` diff --git a/_docs/README_ru.md b/_docs/README_ru.md index 02a1bd1..ff66a0e 100644 --- a/_docs/README_ru.md +++ b/_docs/README_ru.md @@ -9,7 +9,7 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -Инструкции по установке SpoofDPI вы можете найти [здесь](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). +Инструкции по установке SpoofDPI вы можете найти [здесь](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # Использование ``` diff --git a/_docs/README_zh-cn.md b/_docs/README_zh-cn.md index f6ba155..29aa86e 100644 --- a/_docs/README_zh-cn.md +++ b/_docs/README_zh-cn.md @@ -11,7 +11,7 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # 使用方法