add Readme

/ · Jan 11, 2023 · 53900f4 · 53900f4
1 parent 95ce024
commit 53900f4
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 1 deletion.
diff --git a/.img/iperf3.png b/.img/iperf3.png
diff --git a/.img/librespeed.png b/.img/librespeed.png
diff --git a/.img/librespeed_config.png b/.img/librespeed_config.png
diff --git a/.img/speedtest.png b/.img/speedtest.png
diff --git a/README.md b/README.md
@@ -1 +1,46 @@
-# luci-app-netspeedtest
+# LuCI Network Speed Test
+
+### Screenshots
+
+![iperf3](.img/iperf3.png "iperf3")  
+![librespeed](.img/librespeed.png "librespeed")  
+![librespeed_config](.img/librespeed_config.png "librespeed_config")  
+![speedtest](.img/speedtest.png "speedtest")  
+
+### How to install
+
+1. Goto [releases](https://github.com/muink/luci-app-netspeedtest/tree/releases)
+2. Download the latest version of ipk
+3. Login router and goto **System --> Software**
+4. Upload and install ipk
+5. Reboot if the app is not automatically added in page
+6. Goto **Network --> SpeedTest**
+
+### Build
+
+- Compile from OpenWrt/LEDE SDK
+
+```
+# Take the x86_64 platform as an example
+tar xjf openwrt-sdk-21.02.3-x86-64_gcc-8.4.0_musl.Linux-x86_64.tar.xz
+# Go to the SDK root dir
+cd OpenWrt-sdk-*-x86_64_*
+# First run to generate a .config file
+make menuconfig
+./scripts/feeds update -a
+./scripts/feeds install -a
+# Get Makefile
+git clone --depth 1 --branch master --single-branch --no-checkout https://github.com/muink/luci-app-netspeedtest.git package/luci-app-netspeedtest
+pushd package/luci-app-netspeedtest
+umask 022
+git checkout
+popd
+# Select the package LuCI -> Applications -> luci-app-netspeedtest
+make menuconfig
+# Start compiling
+make package/luci-app-netspeedtest/compile V=99
+```
+
+### License
+
+- This project is licensed under the MIT License