Skip to content

Commit 5781fc6

Browse files
committed
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>
1 parent edf338f commit 5781fc6

File tree

2 files changed

+22
-17
lines changed

2 files changed

+22
-17
lines changed

.github/pull_request_template

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ Thanks for your contribution to OpenWrt!
33
To help keep the codebase consistent and readable,
44
and to help people review your contribution,
55
we ask you to follow the rules you find in the wiki at this link
6-
https://lede-project.org/submitting-patches
6+
https://openwrt.org/submitting-patches
77

88
Please remove this message before posting the pull request.

README

+21-16
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
1-
This is the buildsystem for the OpenWrt Linux distribution.
1+
_______ ________ __
2+
| |.-----.-----.-----.| | | |.----.| |_
3+
| - || _ | -__| || | | || _|| _|
4+
|_______|| __|_____|__|__||________||__| |____|
5+
|__| W I R E L E S S F R E E D O M
6+
-----------------------------------------------------
27

3-
Please use "make menuconfig" to choose your preferred
4-
configuration for the toolchain and firmware.
8+
This is the buildsystem for the OpenWrt Linux distribution.
59

6-
You need to have installed gcc, binutils, bzip2, flex, python, perl, make,
7-
find, grep, diff, unzip, gawk, getopt, subversion, libz-dev and libc headers.
10+
To build your own firmware you need a Linux, BSD or MacOSX system (case
11+
sensitive filesystem required) Cygwin is unsupported because of the lack
12+
of a case sensitive file system.
813

9-
Run "./scripts/feeds update -a" to get all the latest package definitions
10-
defined in feeds.conf / feeds.conf.default respectively
11-
and "./scripts/feeds install -a" to install symlinks of all of them into
12-
package/feeds/.
14+
You need gcc, binutils, bzip2, flex, python, perl, make, find, grep, diff,
15+
unzip, gawk, getopt, subversion, libz-dev and libc headers installed.
1316

14-
Use "make menuconfig" to configure your image.
17+
1. Run "./scripts/feeds update -a" to obtain all the latest package definitions
18+
defined in feeds.conf / feeds.conf.default
1519

16-
Simply running "make" will build your firmware.
17-
It will download all sources, build the cross-compile toolchain,
18-
the kernel and all choosen applications.
20+
2. Run "./scripts/feeds install -a" to install symlinks for all obtained
21+
packages into package/feeds/
1922

20-
To build your own firmware you need to have access to a Linux, BSD or MacOSX system
21-
(case-sensitive filesystem required). Cygwin will not be supported because of
22-
the lack of case sensitiveness in the file system.
23+
3. Run "make menuconfig" to select your preferred configuration for the
24+
toolchain, target system & firmware packages.
2325

26+
4. Run "make" to build your firmware. This will download all sources, build
27+
the cross-compile toolchain and then cross-compile the Linux kernel & all
28+
chosen applications for your target system.
2429

2530
Sunshine!
2631
Your OpenWrt Community

0 commit comments

Comments
 (0)