diff options
| author | Kevin Darbyshire-Bryant <ldir@darbyshire-bryant.me.uk> | 2018-07-07 22:23:01 +0100 |
|---|---|---|
| committer | John Crispin <john@phrozen.org> | 2018-08-08 15:32:55 +0200 |
| commit | 888cc05cf578bd0806e337beceddc09ef4d9832a (patch) | |
| tree | a36761d05c5cb911883d7a0b9fa82fdd15287518 | |
| parent | da9a7a9a51b36e700ac451e5b8366030fc14a3cd (diff) | |
| download | upstream-888cc05cf578bd0806e337beceddc09ef4d9832a.tar.gz upstream-888cc05cf578bd0806e337beceddc09ef4d9832a.tar.bz2 upstream-888cc05cf578bd0806e337beceddc09ef4d9832a.zip | |
build: Update README & github help
Update README to include Openwrt branding and improve wording.
Point at the Openwrt wiki in .github templates.
Signed-off-by: Kevin Darbyshire-Bryant <ldir@darbyshire-bryant.me.uk>
(cherry picked from commit 5781fc6b3f4fade6229390c364c7d7cca514ec76)
| -rw-r--r-- | .github/pull_request_template | 2 | ||||
| -rw-r--r-- | README | 37 |
2 files changed, 22 insertions, 17 deletions
diff --git a/.github/pull_request_template b/.github/pull_request_template index e470cef5fc..a2d6bd185f 100644 --- a/.github/pull_request_template +++ b/.github/pull_request_template @@ -3,6 +3,6 @@ Thanks for your contribution to OpenWrt! To help keep the codebase consistent and readable, and to help people review your contribution, we ask you to follow the rules you find in the wiki at this link -https://lede-project.org/submitting-patches +https://openwrt.org/submitting-patches Please remove this message before posting the pull request. @@ -1,26 +1,31 @@ -This is the buildsystem for the OpenWrt Linux distribution. + _______ ________ __ + | |.-----.-----.-----.| | | |.----.| |_ + | - || _ | -__| || | | || _|| _| + |_______|| __|_____|__|__||________||__| |____| + |__| W I R E L E S S F R E E D O M + ----------------------------------------------------- -Please use "make menuconfig" to choose your preferred -configuration for the toolchain and firmware. +This is the buildsystem for the OpenWrt Linux distribution. -You need to have installed gcc, binutils, bzip2, flex, python, perl, make, -find, grep, diff, unzip, gawk, getopt, subversion, libz-dev and libc headers. +To build your own firmware you need a Linux, BSD or MacOSX system (case +sensitive filesystem required) Cygwin is unsupported because of the lack +of a case sensitive file system. -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/. +You need gcc, binutils, bzip2, flex, python, perl, make, find, grep, diff, +unzip, gawk, getopt, subversion, libz-dev and libc headers installed. -Use "make menuconfig" to configure your image. +1. Run "./scripts/feeds update -a" to obtain all the latest package definitions +defined in feeds.conf / feeds.conf.default -Simply running "make" will build your firmware. -It will download all sources, build the cross-compile toolchain, -the kernel and all choosen applications. +2. Run "./scripts/feeds install -a" to install symlinks for all obtained +packages into package/feeds/ -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. +3. Run "make menuconfig" to select your preferred configuration for the +toolchain, target system & firmware packages. +4. Run "make" to build your firmware. This will download all sources, build +the cross-compile toolchain and then cross-compile the Linux kernel & all +chosen applications for your target system. Sunshine! Your OpenWrt Community |