From 316532928dd80ec75cbd29d2d2ca7edf7a43f833 Mon Sep 17 00:00:00 2001 From: xinshouyong Date: Tue, 27 Jul 2021 07:30:01 -0400 Subject: [PATCH] optimize the README.md --- README.md | 158 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 92 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index e16be69..9bcc356 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,92 @@ - -# Under development, please do not use - -## Development - -### Requirements - -You need the following tools to compile OpenWrt, the package names vary between distributions. A complete list with distribution specific packages is found in the [Build System Setup](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem) documentation. - -``` -$ sudo apt install binutils bzip2 diff find flex gawk gcc-6+ getopt grep install libc-dev libz-dev make4.1+ perl python3.6+ rsync subversion unzip which libncurses5-dev zlib1g-dev gawk gcc-multilib g++-multilib flex git-core gettext libssl-dev ocaml sharutils re2c -y -``` - -And This development tools requires Python 3.6 or higher! Please use the following command to check, - -``` -$ python3 --version -Python 3.6.13 - -$ ls -l /usr/bin/python3* - /usr/bin/python3 -> python3.6 - /usr/bin/python3.5 - /usr/bin/python3.5-config -> x86_64-linux-gnu-python3.5-config - /usr/bin/python3.5m - /usr/bin/python3.5m-config -> x86_64-linux-gnu-python3.5m-config - /usr/bin/python3.6 - /usr/bin/python3.6-config -> x86_64-linux-gnu-python3.6-config - /usr/bin/python3.6m - /usr/bin/python3.6m-config -> x86_64-linux-gnu-python3.6m-config - /usr/bin/python3.9 - /usr/bin/python3.9-config -> x86_64-linux-gnu-python3.9-config - /usr/bin/python3-config -> python3.5-config - /usr/bin/python3m -> python3.5m - /usr/bin/python3m-config -> python3.5m-config -``` - -### Quickstart - -1. Clone repository, - -``` -$ git clone https://github.com/gl-inet/gl-infra-builder.git -``` - -2. If you have a [offline dl folder](https://sources.openwrt.org/), you can make a symlink to feeds/dl, it will make compilation easier, - -``` -$ cd gl-infra-builder -$ ln -sf /data/dl feeds/ -``` - -3. Setup, auto download openwrt-19.07.7 by default and auto config, - -``` -$ python3 setup.py -``` - -4. Generate your target configuration, - -``` -$ ./scripts/gen_config.py list # show available profile -$ ./scripts/gen_config.py -``` - -5. Run `make` to build your firmware. - +# Under development, please do not use + +## Requirements + +You need the following tools to compile OpenWrt, the package names vary between distributions. A complete list with distribution specific packages is found in the [Build System Setup](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem) documentation. + +``` +$ sudo apt install binutils bzip2 diff find flex gawk gcc-6+ getopt grep install libc-dev libz-dev make4.1+ perl python3.6+ rsync subversion unzip which libncurses5-dev zlib1g-dev gawk gcc-multilib g++-multilib flex git-core gettext libssl-dev ocaml sharutils re2c -y +``` + +And This development tools requires Python 3.6 or higher! Please use the following command to check, + +``` +$ python3 --version +Python 3.6.13 + +$ ls -l /usr/bin/python3* + /usr/bin/python3 -> python3.6 + /usr/bin/python3.5 + /usr/bin/python3.5-config -> x86_64-linux-gnu-python3.5-config + /usr/bin/python3.5m + /usr/bin/python3.5m-config -> x86_64-linux-gnu-python3.5m-config + /usr/bin/python3.6 + /usr/bin/python3.6-config -> x86_64-linux-gnu-python3.6-config + /usr/bin/python3.6m + /usr/bin/python3.6m-config -> x86_64-linux-gnu-python3.6m-config + /usr/bin/python3.9 + /usr/bin/python3.9-config -> x86_64-linux-gnu-python3.9-config + /usr/bin/python3-config -> python3.5-config + /usr/bin/python3m -> python3.5m + /usr/bin/python3m-config -> python3.5m-config +``` + +### Quickstart + +1. Clone repository. + +``` +$ git clone https://github.com/gl-inet/gl-infra-builder.git +``` + +``` +$ cd gl-infra-builder +``` + +2. If you have a [offline dl folder](https://sources.openwrt.org/) and corresponding packages, you can make a symlink to feeds/dl (assuming the dl location is /data/dl), it will make compilation easier. If there is no dl and corresponding packages, ignore this command. + +``` +$ ln -sf /data/dl feeds/ +``` + +3. Setup, the command will auto download openwrt-19.07.7 by default and auto config, and then patch all the the GL product Patches + +``` +$ python3 setup.py +$ cd openwrt-19.07/openwrt-19.07.7/ +``` + +Note: If you want to use different branch, please use the -c parameter, for example. If you want to use 18.06 + +``` +$ python3 setup.py -c config-18.x.yml +$ cd openwrt-18.06 +``` + +4. Generate your target configuration. (For the following content, we will continue to take 19.07 as an example) + +``` +$ ./scripts/gen_config.py list # show available profile +$ ./scripts/gen_config.py +``` +Note: excute ./scripts/gen_config.py list command, you can get Target Profiles and Function Profiles. Target Profiles is you want to compile products, don't modify. Function Profiles is you want to add/delete packages, you can modify. Those files in the **profiles** directory. + +For example, If you want to compile GL-AR150 product you can use command: +``` +$ ./scripts/gen_config.py target_ar71xx_gl-ar150 +``` + +If you want to compile GL-AR150 product and add some packages, you can excute **make menuconfig** to chose the product and other packages. + +5. Run `make` to build your firmware. + +Note: If you gcc version is 10, you will encounter some error, like this: +``` +/usr/bin/ld: scripts/dtc/dtc-parser.tab.o:(.bss+0x10): multiple definition of `yylloc'; scripts/dtc/dtc-lexer.lex.o:(.bss+0x0): first defined here +collect2: error：ld returned 1 exit status. +``` +You should execute the following command to reduce the gcc version: +``` +update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-9 100 +update-alternatives --config gcc +``` \ No newline at end of file