From 8710feec935df677f25d1a556b267402d5cbb828 Mon Sep 17 00:00:00 2001 From: Leung Yau Ming Date: Sat, 6 Mar 2021 00:29:04 +0800 Subject: [PATCH] Separate READMEs and minor improvements (#6472) * docs(chinese): remove english version and format readme * docs(english): add english readme --- README.md | 84 +++++++++++-------------------------------------- README_EN.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+), 66 deletions(-) create mode 100644 README_EN.md diff --git a/README.md b/README.md index c123bd0a4..73cb532bd 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ 欢迎来到Lean的Openwrt源码仓库！ = -Welcome to Lean's git source of OpenWrt and packages -= -中文：如何编译自己需要的 OpenWrt 固件 + +[English](./README_EN.md) + +如何编译自己需要的 OpenWrt 固件 - 注意： - 1. **不**要用 **root** 用户进行编译！！！ 2. 国内用户编译前最好准备好梯子 -3. 默认登陆IP 192.168.1.1, 密码 password +3. 默认登陆IP 192.168.1.1 密码 password 4. 免责声明：本人不欢迎例如 nobk 这种傻逼使用或者访问本源代码哪怕一个字节，否则一旦他家里因此而发生各种全家富贵的情况，与本人一律无关 编译命令如下: - -1. 首先装好 Ubuntu 64bit，推荐 Ubuntu 18 LTS x64 +1. 首先装好 Ubuntu 64bit，推荐 Ubuntu 18 LTS x64 2. 命令行输入 `sudo apt-get update` ，然后输入 -` -sudo apt-get -y install build-essential asciidoc binutils bzip2 gawk gettext git libncurses5-dev libz-dev patch python3 python2.7 unzip zlib1g-dev lib32gcc1 libc6-dev-i386 subversion flex uglifyjs git-core gcc-multilib p7zip p7zip-full msmtp libssl-dev texinfo libglib2.0-dev xmlto qemu-utils upx libelf-dev autoconf automake libtool autopoint device-tree-compiler g++-multilib antlr3 gperf wget curl swig rsync -` + ` + sudo apt-get -y install build-essential asciidoc binutils bzip2 gawk gettext git libncurses5-dev libz-dev patch python3 python2.7 unzip zlib1g-dev lib32gcc1 libc6-dev-i386 subversion flex uglifyjs git-core gcc-multilib p7zip p7zip-full msmtp libssl-dev texinfo libglib2.0-dev xmlto qemu-utils upx libelf-dev autoconf automake libtool autopoint device-tree-compiler g++-multilib antlr3 gperf wget curl swig rsync + ` 3. 使用 `git clone https://github.com/coolsnowwolf/lede` 命令下载好源代码，然后 `cd lede` 进入目录 @@ -31,7 +32,6 @@ sudo apt-get -y install build-essential asciidoc binutils bzip2 gawk gettext git 5. `make -j8 download V=s` 下载dl库（国内请尽量全局科学上网） - 6. 输入 `make -j1 V=s` （-j1 后面是线程数。第一次编译推荐用单线程）即可开始编译你要的固件了。 本套代码保证肯定可以编译成功。里面包括了 R20 所有源代码，包括 IPK 的。 @@ -56,80 +56,32 @@ make menuconfig make -j$(($(nproc) + 1)) V=s ``` -编译完成后输出路径：/lede/bin/targets +编译完成后输出路径：bin/targets 特别提示： ------ -1.源代码中绝不含任何后门和可以监控或者劫持你的 HTTPS 的闭源软件，SSL 安全是互联网最后的壁垒。安全干净才是固件应该做到的； +1. 源代码中绝不含任何后门和可以监控或者劫持你的 HTTPS 的闭源软件， SSL 安全是互联网最后的壁垒。安全干净才是固件应该做到的； -2.如有技术问题需要讨论，欢迎加入 QQ 讨论群：OP共享技术交流群 ,号码 297253733 ，加群链接: 点击链接加入群聊【OP共享技术交流群】：[点击加入](https://jq.qq.com/?_wv=1027&k=5yCRuXL "OP共享技术交流群") +2. 如有技术问题需要讨论，欢迎加入 QQ 讨论群： OP 共享技术交流群 ,号码 297253733 ，加群链接: 点击链接加入群聊【 OP 共享技术交流群】：[点击加入](https://jq.qq.com/?_wv=1027&k=5yCRuXL "OP共享技术交流群") -3.想学习OpenWrt开发，但是摸不着门道？自学没毅力？基础太差？怕太难学不会？跟着佐大学OpenWrt开发入门培训班助你能学有所成 +3. 想学习 OpenWrt 开发，但是摸不着门道？自学没毅力？基础太差？怕太难学不会？跟着佐大学 OpenWrt 开发入门培训班助你能学有所成 报名地址：[点击报名](http://forgotfun.org/2018/04/openwrt-training-2018.html "报名") ## 软路由介绍 -友情推荐不恰饭：如果你在寻找一个低功耗小体积性能不错的 x86/x64 路由器，我个人建议可以考虑 -小马v1 的铝合金版本 (N3710 4千兆)：[页面介绍](https://item.taobao.com/item.htm?spm=a230r.1.14.20.144c763fRkK0VZ&id=561126544764 " 小马v1 的铝合金版本") +友情推荐不恰饭：如果你在寻找一个低功耗小体积性能不错的 x86 / x64 路由器，我个人建议可以考虑 +小马v1 的铝合金版本 ( N3710 4千兆)：[页面介绍](https://item.taobao.com/item.htm?spm=a230r.1.14.20.144c763fRkK0VZ&id=561126544764 " 小马v1 的铝合金版本") ![xm1](doc/xm5.jpg) ![xm2](doc/xm6.jpg) -## Donate +## 捐贈 如果你觉得此项目对你有帮助，可以捐助我们，以鼓励项目能持续发展，更加完善 -### Alipay 支付宝 +### 支付宝 ![alipay](doc/alipay_donate.jpg) -### Wechat 微信 +### 微信 ![wechat](doc/wechat_donate.jpg) - ------- - -English Version: How to make your Openwrt firmware. -- -Note: --- -1. DO **NOT** USE **ROOT** USER TO CONFIGURE!!! - -2. Login IP is 192.168.1.1 and login password is "password". - -Let's start! ---- -First, you need a computer with a linux system. It's better to use Ubuntu 18 LTS 64-bit. - -Next you need gcc, binutils, bzip2, flex, python3.5+, perl, make, find, grep, diff, unzip, gawk, getopt, subversion, libz-dev and libc headers installed. - -To install these program, please login root users and type -` -sudo apt-get -y install build-essential asciidoc binutils bzip2 gawk gettext git libncurses5-dev libz-dev patch python3.5 python2.7 unzip zlib1g-dev lib32gcc1 libc6-dev-i386 subversion flex uglifyjs git-core gcc-multilib p7zip p7zip-full msmtp libssl-dev texinfo libglib2.0-dev xmlto qemu-utils upx libelf-dev autoconf automake libtool autopoint device-tree-compiler g++-multilib antlr3 gperf wget swig rsync -` -in terminal - -Third, logout of root users. And type this `git clone https://github.com/coolsnowwolf/lede` in terminal to clone this source. - -After these please type `cd lede` to cd into the source. - -Please Run `./scripts/feeds update -a` to get all the latest package definitions -defined in `feeds.conf` / `feeds.conf.default` respectively -and `./scripts/feeds install -a` to install symlinks of all of them into -`package/feeds/` . - -Please use `make menuconfig` to choose your preferred -configuration for the toolchain and firmware. - -Use `make menuconfig` to configure your image. - -Simply running `make` will build your firmware. -It will download all sources, build the cross-compile toolchain, -the kernel and all chosen applications. - -To build your own firmware you need to have access to a Linux, BSD or MacOSX system -(case-sensitive filesystem required). Cygwin will not be supported because of -the lack of case sensitiveness in the file system. - -## Note: Addition Lean's private package source code in `./package/lean` directory. Use it under GPL v3. - -## GPLv3 is compatible with more licenses than GPLv2: it allows you to make combinations with code that has specific kinds of additional requirements that are not in GPLv3 itself. Section 7 has more information about this, including the list of additional requirements that are permitted. diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 000000000..9ca1155eb --- /dev/null +++ b/README_EN.md @@ -0,0 +1,88 @@ +Welcome to Lean's git source of OpenWrt and packages += + +How to build your Openwrt firmware. +- +Note: +-- +1. DO **NOT** USE **root** USER!!! + +2. Users within China should prepare proxy before building. + +3. Web admin panel default IP is 192.168.1.1 and default password is "password". + +Let's start! +--- +1. First, install Ubuntu 64bit (Ubuntu 18 LTS x86 is recommended). + +2. Run `sudo apt-get update` in the terminal, and then run + ` + sudo apt-get -y install build-essential asciidoc binutils bzip2 gawk gettext git libncurses5-dev libz-dev patch python3 python2.7 unzip zlib1g-dev lib32gcc1 libc6-dev-i386 subversion flex uglifyjs git-core gcc-multilib p7zip p7zip-full msmtp libssl-dev texinfo libglib2.0-dev xmlto qemu-utils upx libelf-dev autoconf automake libtool autopoint device-tree-compiler g++-multilib antlr3 gperf wget curl swig rsync + ` + +3. Run `git clone https://github.com/coolsnowwolf/lede` to clone the source, and then `cd lede` to enter the directory + +4. ```bash + ./scripts/feeds update -a + ./scripts/feeds install -a + make menuconfig + ``` + +5. Run `make -j8 download V=s` to download libraries and dependencies (please use global proxy when possible) + +6. Run `make -j1 V=s` (integer following -j is the thread count, single-thread is recommended for the first build) to start building your firmware. + +This source code is promised to be compiled successfully. + +You can use this source code freely, but please link this GitHub repository when redistributing. Thank you for your cooperation! += + +Rebuild: +```bash +cd lede +git pull +./scripts/feeds update -a && ./scripts/feeds install -a +make defconfig +make -j8 download +make -j$(($(nproc) + 1)) V=s +``` + +If reconfiguration is need: +```bash +rm -rf ./tmp && rm -rf .config +make menuconfig +make -j$(($(nproc) + 1)) V=s +``` + +Build result will be produced to `bin/targets` directory. + +Special tips: +------ +1. This source code doesn't contain any backdoors or close source applications that can monitor/capture your HTTPS traffic, SSL is the final castle of cyber security. Safe is what a firmware should archive. + +2. If you have any technical problem, you may join the QQ discussion group: 297253733, link: click [here](https://jq.qq.com/?_wv=1027&k=5yCRuXL) + +3. Want to learn OpenWrt development but don't know how? Can't hold long for self-learning? Not enough fundamental knowledge? Learn OpenWrt development with Mr. Zuo through his Beginner OpenWrt Training Course. Click [here](http://forgotfun.org/2018/04/openwrt-training-2018.html) to register. + +## Router Recommendation +Not Sponsored: If you are finding a low power consumption, small and performance promising x86/x64 router, I personally recommend the +EZPROv1 Alumium Edition (N3710 4000M): [Details](https://item.taobao.com/item.htm?spm=a230r.1.14.20.144c763fRkK0VZ&id=561126544764) + +![xm1](doc/xm5.jpg) +![xm2](doc/xm6.jpg) + +## Donation + +If this project does help you, please consider donating to support the development of this project. + +### Alipay + +![alipay](doc/alipay_donate.jpg) + +### WeChat + +![wechat](doc/wechat_donate.jpg) + +## Note: Addition Lean's private package source code in `./package/lean` directory. Use it under GPL v3. + +## GPLv3 is compatible with more licenses than GPLv2: it allows you to make combinations with code that has specific kinds of additional requirements that are not in GPLv3 itself. Section 7 has more information about this, including the list of additional requirements that are permitted.