OpenWrt Source Repository
Go to file
Paul Spooren d0113711a3 README: port to 21st century
The README is no longer important to only developers but also users.
Reflect that by adding valuable information for everyone new to OpenWrt!

Sunshine

Signed-off-by: Paul Spooren <mail@aparcar.org>
[remove trailing whitespace and empty line at EOF]
Signed-off-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>
2020-08-02 15:44:40 +02:00
.github
config kernel: fix missing TRANSPARENT_HUGEPAGE symbols 2020-08-01 14:33:46 +01:00
include base-files: fwtool: make compat_version backward compatible 2020-07-31 11:40:15 +02:00
package openvpn: revise sample configuration 2020-08-01 14:54:39 +01:00
scripts build: add option to mark devices as BROKEN 2020-07-30 21:49:07 +02:00
target ath79/mikrotik: create shared device definitions for nor and nand 2020-08-01 18:31:24 +02:00
toolchain toolchain: add PKG_RELEASE if local files 2020-07-29 17:13:51 +02:00
tools tools/mkimage: create .itb file with read-access for group,other not just owner. 2020-07-23 14:25:10 -04:00
.gitattributes
.gitignore build: improve ccache support 2020-07-11 15:19:53 +02:00
BSDmakefile
Config.in
LICENSE
Makefile build: improve ccache support 2020-07-11 15:19:53 +02:00
README.md README: port to 21st century 2020-08-02 15:44:40 +02:00
feeds.conf.default
logo.svg README: port to 21st century 2020-08-02 15:44:40 +02:00
rules.mk build: improve ccache support 2020-07-11 15:19:53 +02:00

README.md

OpenWrt logo

OpenWrt Project is a Linux operating system targeting embedded devices. Instead of trying to create a single, static firmware, OpenWrt provides a fully writable filesystem with package management. This frees you from the application selection and configuration provided by the vendor and allows you to customize the device through the use of packages to suit any application. For developers, OpenWrt is the framework to build an application without having to build a complete firmware around it; for users this means the ability for full customization, to use the device in ways never envisioned.

Sunshine!

Development

To build your own firmware you need a GNU/Linux, BSD or MacOSX system (case sensitive filesystem required). Cygwin is unsupported because of the lack of a case sensitive file system.

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 documentation.

gcc binutils bzip2 flex python3 perl make find grep diff unzip gawk getopt
subversion libz-dev libc-dev

Quickstart

  1. Run ./scripts/feeds update -a to obtain all the latest package definitions defined in feeds.conf / feeds.conf.default

  2. Run ./scripts/feeds install -a to install symlinks for all obtained packages into package/feeds/

  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 GNU/Linux kernel & all chosen applications for your target system.

The main repository uses multiple sub-repositories to manage packages of different categories. All packages are installed via the OpenWrt package manager called opkg. If you're looking to develop the web interface or port packages to OpenWrt, please find the fitting repository below.

Support Information

For a list of supported devices see the OpenWrt Hardware Database

Documentation

Support Community

  • Forum: For usage, projects, discussions and hardware advise.
  • Support Chat: Channel #openwrt on freenode.net.

Developer Community

License

OpenWrt is licensed under GPL-2.0