KumiSystems/openwrtv3
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

build: Update README & github help

Browse source 
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>
This commit is contained in:
Kevin Darbyshire-Bryant 2018-07-07 22:23:01 +01:00
parent edf338f248
commit 5781fc6b3f
2 changed files with 22 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/pull_request_template vendored
View file

@ -3,6 +3,6 @@ Thanks for your contribution to OpenWrt!
To help keep the codebase consistent and readable, To help keep the codebase consistent and readable,
and to help people review your contribution, and to help people review your contribution,
we ask you to follow the rules you find in the wiki at this link 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. Please remove this message before posting the pull request.

37
README
View file

@ -1,26 +1,31 @@
_______ ________ __
| |.-----.-----.-----.| | | |.----.| |_
| - || _ | -__| || | | || _|| _|
|_______|| __|_____|__|__||________||__| |____|
|__| W I R E L E S S F R E E D O M
-----------------------------------------------------
This is the buildsystem for the OpenWrt Linux distribution. This is the buildsystem for the OpenWrt Linux distribution.
Please use "make menuconfig" to choose your preferred To build your own firmware you need a Linux, BSD or MacOSX system (case
configuration for the toolchain and firmware. sensitive filesystem required) Cygwin is unsupported because of the lack
of a case sensitive file system.
You need to have installed gcc, binutils, bzip2, flex, python, perl, make, You need gcc, binutils, bzip2, flex, python, perl, make, find, grep, diff,
find, grep, diff, unzip, gawk, getopt, subversion, libz-dev and libc headers. unzip, gawk, getopt, subversion, libz-dev and libc headers installed.
Run "./scripts/feeds update -a" to get all the latest package definitions 1. Run "./scripts/feeds update -a" to obtain all the latest package definitions
defined in feeds.conf / feeds.conf.default respectively defined in feeds.conf / feeds.conf.default
and "./scripts/feeds install -a" to install symlinks of all of them into
package/feeds/.
Use "make menuconfig" to configure your image. 2. Run "./scripts/feeds install -a" to install symlinks for all obtained
packages into package/feeds/
Simply running "make" will build your firmware. 3. Run "make menuconfig" to select your preferred configuration for the
It will download all sources, build the cross-compile toolchain, toolchain, target system & firmware packages.
the kernel and all choosen 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.
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! Sunshine!
Your OpenWrt Community Your OpenWrt Community