Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pymumu committed Oct 20, 2022
1 parent efc1899 commit 51e1ba6
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 13 deletions.
21 changes: 21 additions & 0 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ SmartDNS 同时支持指定特定域名 IP 地址,并高性匹配,可达到
- [特性](#特性)
- [架构](#架构)
- [下载](#下载)
- [使用官方安装源](#使用官方安装源)
- [手工下载安装](#手工下载安装)
- [安装和使用](#安装和使用)
- [标准 Linux 系统 / 树莓派](#标准-linux-系统--树莓派)
- [OpenWrt](#openwrt)
Expand Down Expand Up @@ -121,6 +123,9 @@ rtt min/avg/max/mdev = 5.954/6.133/6.313/0.195 ms
9. **高性能、占用资源少**
多线程异步 IO 模式,cache 缓存查询结果。

10. **主流系统官方支持**
主流路由系统官方软件源安装smartdns。

## 架构

![Architecture](https://github.com/pymumu/test/releases/download/blob/architecture.png)
Expand All @@ -132,6 +137,19 @@ rtt min/avg/max/mdev = 5.954/6.133/6.313/0.195 ms

## 下载

### 使用官方安装源

smartdns已经合入主流系统的软件仓库,可以直接使用系统安装命令直接安装。

系统|安装方式|说明|
--|--|--
openwrt|opkg update</br>opkg install luci-app-smartdns</br>opkg install smartdns|22.03之后的系统。软件源路径:https://downloads.openwrt.org/releases/
ddwrt|官方最新固件service页面->SmartDNS Resolver->启用。|选择界面参考:https://forum.dd-wrt.com/demo/Services.html
debian|apt-get install smartdns|
entware|ipkg update</br>ipkg install smartdns|软件源路径:https://bin.entware.net/

### 手工下载安装

--------------

下载对应系统或固件版本的 SmartDNS 安装包,对应关系如下。
Expand Down Expand Up @@ -723,6 +741,9 @@ rtt min/avg/max/mdev = 5.954/6.133/6.313/0.195 ms
...
```

14. 更多问题
如有更多问题,请查阅或提交issue: [https://github.com/pymumu/smartdns/issues](https://github.com/pymumu/smartdns/issues)

## 编译

SmartDNS 提供了编译软件包的脚本(`package/build-pkg.sh`),支持编译 LuCI、Debian、OpenWrt 和 Optware 安装包。
Expand Down
48 changes: 35 additions & 13 deletions ReadMe_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,27 @@ Support Raspberry Pi, openwrt, ASUS router, Windows and other devices.

## Table Of Content

1. [Software Show](#software-show)
1. [Features](#features)
1. [Architecture](#architecture)
1. [Usage](#usage)
1. [Download the package](#download-the-package)
1. [Standard Linux system installation/Raspberry Pi, X86_64 system](#standard-linux-system-installation/raspberry-pi,-x86_64-system)
1. [openwrt/LEDE](#openwrt/lede)
1. [ASUS router native firmware / Merlin firmware](#asus-router-native-firmware-/-merlin-firmware)
1. [optware/entware](#optware/entware)
1. [Windows 10 WSL Installation/WSL ubuntu](#windows-10-wsl-installation/wsl-ubuntu)
1. [Configuration parameter](#configuration-parameter)
1. [Donate](#Donate)
1. [FAQ](#FAQ)
- [SmartDNS](#smartdns)
- [Table Of Content](#table-of-content)
- [Software Show](#software-show)
- [Features](#features)
- [Architecture](#architecture)
- [Usage](#usage)
- [Use official installation source](#use-official-installation-source)
- [Download the package](#download-the-package)
- [Standard Linux system installation/Raspberry Pi, X86_64 system](#standard-linux-system-installationraspberry-pi-x86_64-system)
- [openwrt](#openwrt)
- [ASUS router native firmware / Merlin firmware](#asus-router-native-firmware--merlin-firmware)
- [optware/entware](#optwareentware)
- [Windows 10 WSL Installation/WSL ubuntu](#windows-10-wsl-installationwsl-ubuntu)
- [Configuration parameter](#configuration-parameter)
- [FAQ](#faq)
- [Compile](#compile)
- [Donate](#donate)
- [PayPal](#paypal)
- [Alipay](#alipay)
- [Wechat](#wechat)
- [Open Source License](#open-source-license)

## Software Show

Expand Down Expand Up @@ -121,6 +129,17 @@ From the comparison, smartdns found the fastest IP address to visit www.baidu.co

## Usage

### Use official installation source

smartdns can already be installed using system package management tools.

System|Installation|Instructions|
--|--|--
openwrt|opkg update</br>opkg install luci-app-smartdns</br>opkg install smartdns|systems after 22.03. Software source: https://downloads.openwrt.org/releases/
ddwrt|latest firmware. goto services page abd enable SmartDNS Resolver. |Demo: https://forum.dd-wrt.com/demo/Services.html
debian|apt-get install smartdns|
entware|ipkg update</br>ipkg install smartdns|Software source: https://bin.entware.net/

### Download the package

--------------
Expand Down Expand Up @@ -664,6 +683,9 @@ Note: Merlin firmware is derived from ASUS firmware and can theoretically be use
...
````
1. More questions
More questions, please read issue: [https://github.com/pymumu/smartdns/issues](https://github.com/pymumu/smartdns/issues)
## Compile
smartdns contains scripts for compiling packages, supports compiling luci, debian, openwrt, opare installation packages, and can execute `package/build-pkg.sh` compilation.
Expand Down

0 comments on commit 51e1ba6

Please sign in to comment.