mirrors/dae
1
0
Fork 0
mirror of https://github.com/daeuniverse/dae.git synced 2025-03-10 04:47:25 +07:00
Code Issues Packages Projects Releases Wiki Activity

doc: add usage contents back; temporarily replicated to ./docs/README

Browse Source
This commit is contained in:
yqlbu 2023-02-19 20:06:10 +08:00
parent b1f30805c2
commit 3e40e2c1cb
No known key found for this signature in database
GPG Key ID: B94F394B72884017
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -79,6 +79,53 @@ EOF
sudo sysctl --system
```
## Usage
### Build
**Make Dependencies**
```shell
clang >= 10
llvm >= 10
golang >= 1.18
make
```
**Build**
```shell
git clone https://github.com/v2rayA/dae.git
cd dae
git submodule update --init
# Minimal dependency build:
make GOFLAGS="-buildvcs=false" CC=clang
# Or normal build:
# make
```
### Run
**Runtime Dependencies**
Download [geoip.dat](https://github.com/v2ray/geoip/releases/latest) and [geosite.dat](https://github.com/v2fly/domain-list-community/releases/latest) to `/usr/local/share/dae/`.
```
mkdir -p /usr/local/share/dae/
pushd /usr/local/share/dae/
curl -L -o geoip.dat https://github.com/v2ray/geoip/releases/latest/download/geoip.dat
curl -L -o geosite.dat https://github.com/v2ray/domain-list-community/releases/latest/download/dlc.dat
popd
```
**Run**
```shell
./dae run -c example.dae
```
See [example.dae](https://github.com/v2rayA/dae/blob/main/example.dae).
## Getting Started
Please refer to [Quick Start Guide](./docs/getting-started/README.md) to start using `Dae` right away!