OpenWrt Source Repository
Go to file
Paul Spooren efee640716 busybox: mention SRV support in help message
The SRV was added some time ago and should be mentioned in the short
help message to avoid confusion about missing features.

Signed-off-by: Paul Spooren <mail@aparcar.org>
2021-05-24 20:30:04 +02:00
.github
LICENSES
config treewide: fix spelling 'seperate' -> 'separate' 2021-02-28 23:59:21 +00:00
include prereq-build: g++ formatting and consistency fixes 2021-05-23 15:11:38 +02:00
package busybox: mention SRV support in help message 2021-05-24 20:30:04 +02:00
scripts build: introduce $(MKHASH) 2021-05-13 15:13:15 +02:00
target mediatek: update mtd parser patches 2021-05-23 17:10:17 +02:00
toolchain toolchain/gdb: fix broken configure test for ELF support 2021-05-18 12:52:52 +02:00
tools ccache: Build with ENABLE_DOCUMENTATION=OFF 2021-05-23 15:11:38 +02:00
.gitattributes
.gitignore gitignore: add .vscode for VS Code users 2021-03-08 10:46:06 +01:00
BSDmakefile
COPYING COPYING: add COPYING file to specify project licenses 2021-02-14 19:21:38 +01:00
Config.in
Makefile Revert "build: replace which with Bash command built-in" 2021-03-03 22:51:39 +01:00
README.md README: add install command to build requirements 2021-03-26 19:57:20 +01:00
feeds.conf.default feeds: management: remove dead and out of project feed 2021-05-01 00:37:15 +02:00
rules.mk build: introduce $(MKHASH) 2021-05-13 15:13:15 +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.

binutils bzip2 diff find flex gawk gcc-6+ getopt grep install libc-dev libz-dev
make4.1+ perl python3.6+ rsync subversion unzip which

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