docs(getting-started): add ref to run-as-daemon (#147)

* docs(getting-started): add ref to run-as-daemon * fix: fix typos * docs(run-as-daemon): add chmod and helper * docs: fix heading; reduce confusion * fix: fix broken links * docs(run-as-daemon): add check version comment * docs(getting-started): add notes for manual installation * fix: fix typos * fix: fix typo * patch: correct cn_trans * fix: fix typos * style(build-by-yourself): apply notes styling * fix: fix autocorrect
daeuniverse · Jun 24, 2023 · c578f2a · c578f2a
1 parent 6458ebd
commit c578f2a
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 4 deletions.
diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md
@@ -117,6 +117,12 @@ git clone --depth=1 https://github.com/daeuniverse/dae
 docker compose up -d --build
 ```
 
+## Manual installation
+
+> **Note**: This approach is **ONLY** recommended for `advanced` users. With this approach, users may have flexibility to test various versions of dae. Noted that newly introduced features are sometimes buggy, do it at your own risk.
+
+dae can run as a daemon (systemd) service. See [run-as-daemon](run-as-daemon.md)
+
 ### Installation Script
 
 See [daeuniverse/dae-installer](https://github.com/daeuniverse/dae-installer) (or [mirror](https://hubmirror.v2raya.org/daeuniverse/dae-installer)).

diff --git a/docs/getting-started/README_zh.md b/docs/getting-started/README_zh.md
@@ -111,6 +111,12 @@ git clone --depth=1 https://github.com/daeuniverse/dae
 docker compose up -d --build
 ```
 
+### 手动安装
+
+> **Note**: 这种方法仅建议高级用户使用。采用这种方法，用户可以灵活地测试各个版本的 dae。请注意，新引入的功能有时可能存在 bug，因此请自行承担风险。
+
+dae 可以以守护进程（systemd）的形式运行，见 [run as daemon](run-as-daemon.md)。
+
 ### 安装脚本
 
 见 [daeuniverse/dae-installer](https://github.com/daeuniverse/dae-installer)（或使用 [镜像站](https://hubmirror.v2raya.org/daeuniverse/dae-installer)）。

diff --git a/docs/getting-started/build-by-yourself.md b/docs/getting-started/build-by-yourself.md
@@ -62,4 +62,4 @@ After fine tuning, run dae:
 ./dae run -c example.dae
 ```
 
-Alternatively, you may run dae as a daemon(systemd) service. Check out more details [HERE](./run-as-daemon.md).
+> **Note**: Alternatively, you may run dae as a daemon (systemd) service. Check out more details [HERE](run-as-daemon.md).
diff --git a/docs/getting-started/run-as-daemon.md b/docs/getting-started/run-as-daemon.md
@@ -2,10 +2,9 @@
 
 [systemd](https://wiki.debian.org/systemd) allows you to create and manage services in extremely powerful and flexible ways.
 
-> **Note**
-> If your distribution's service manager is provided by systemd.
+> **Note**: (Prerequisites) If your distribution's service manager is provided by systemd.
 
-dae can run as a daemon(systemd) service so that it can run at boot.
+dae can run as a daemon (systemd) service so that it can run at boot.
 
 ## Prerequisites
 
@@ -32,6 +31,24 @@ mkdir -p /etc/dae
 curl -L -o /etc/dae/config.dae https://github.com/daeuniverse/dae/raw/main/example.dae
 ```
 
+## Download pre-compiled binaries
+
+Releases are available in <https://github.com/daeuniverse/daed/releases>
+
+> **Note**: If you would like to get a taste of new features, there are nightly (latest) builds available. Most of the time, newly proposed changes will be included in `PRs` and will be exported as cross-platform executable binaries in builds (GitHub Action Workflow Build). Noted that newly introduced features are sometimes buggy, do it at your own risk. However, we still highly encourage you to check out our latest builds as it may help us further analyze features stability and resolve potential bugs accordingly.
+
+Nightly builds are available in <https://github.com/daeuniverse/dae/actions/workflows/build-nightly.yml>
+
+```bash
+sudo chmod +x ./dae
+sudo install -Dm755 dae /usr/bin/
+
+# helper
+dae [-h,--help]
+# check version
+dae version
+```
+
 ## Setup
 
 ```bash