mirror/ openwrt
1
0
Fork 0
mirror of https://git.openwrt.org/openwrt/openwrt.git synced 2024-04-24 19:05:06 +02:00
Code Issues
openwrt/README.md

109 lines
4.2 KiB
Markdown
Raw Permalink Normal View History

README: mv logo.svg include/logo.{png,svg} Some Git hoster (e.g. sr.ht) disable hosting of svg images (xml) to avoid XSS attacks. To show the logo correctly on all code hosters use a "safe" PNG image. Also move logo(s) to include/ folder to lower autocomplete churn with the `logs/` folder. While at it, replace absolute logo path and make it relative, as this may break other code hosters as well. Signed-off-by: Paul Spooren <mail@aparcar.org>
2020-11-27 10:23:41 +01:00
![OpenWrt logo](include/logo.png)
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-07-16 10:19:37 +02:00
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!
README: add download section The *Firmware Selector* was built to simplify users finding suitable images for their devices. Let's give it more visibility so unleashing your home router becomes an easier thing. As an alternative for more advanced user, provide the directl link to the wiki download section. Signed-off-by: Paul Spooren <mail@aparcar.org> [ fix typo in commit description, add link to Wiki download page ] Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
2021-09-09 10:57:46 +02:00
## Download
Built firmware images are available for many architectures and come with a
package selection to be used as WiFi home router. To quickly find a factory
image usable to migrate from a vendor stock firmware to OpenWrt, try the
*Firmware Selector*.
* [OpenWrt Firmware Selector](https://firmware-selector.openwrt.org/)
If your device is supported, please follow the **Info** link to see install
instructions or consult the support resources listed below.
##
An advanced user may require additional or specific package. (Toolchain, SDK, ...) For everything else than simple firmware download, try the wiki download page:
* [OpenWrt Wiki Download](https://openwrt.org/downloads)
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-07-16 10:19:37 +02:00
## Development
README: replace "MacOSX" with "macOS" In October 2018, the last version of the operating system named "Mac OS X" ended its life cycle. It's time to change it to "macOS". Signed-off-by: Gentry Deng <me@gend.moe>
2024-03-31 15:42:12 +02:00
To build your own firmware you need a GNU/Linux, BSD or macOS system (case
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-07-16 10:19:37 +02:00
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](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem)
documentation.
```
README: add install command to build requirements In commit 8c8496435a9d ("build: add GNU install to prerequisites") new dependency was added, but addition to README was omitted. Fixes: 8c8496435a9d ("build: add GNU install to prerequisites") Signed-off-by: Petr Štetiar <ynezz@true.cz>
2021-03-25 08:01:08 +01:00
binutils bzip2 diff find flex gawk gcc-6+ getopt grep install libc-dev libz-dev
build: drop support for python 3.6 python 3.6 EOL was Dec. 2021 buildbot is running debian 10 which ships with 3.7 meson 0.62+ requires 3.7 Signed-off-by: Doug Kerr <dek3rr@gmail.com> Signed-off-by: Petr Štetiar <ynezz@true.cz> [rebased]
2022-09-09 01:07:18 +02:00
make4.1+ perl python3.7+ rsync subversion unzip which
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-07-16 10:19:37 +02:00
```
### 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.
### Related Repositories
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.
* [LuCI Web Interface](https://github.com/openwrt/luci): Modern and modular
interface to control the device via a web browser.
* [OpenWrt Packages](https://github.com/openwrt/packages): Community repository
of ported packages.
README: update routing.git URL The routing packages feed moved from `openwrt-routing/packages` to `openwrt/routing`, reflect that in the README. Signed-off-by: Paul Spooren <mail@aparcar.org>
2021-06-12 20:27:16 +02:00
* [OpenWrt Routing](https://github.com/openwrt/routing): Packages specifically
focused on (mesh) routing.
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-07-16 10:19:37 +02:00
README: mention video feed The video feed just got support for Wayland which allows OpenWrt devices to run as a Kiosk (displaying browser content via a display). The availability of these packages should be mentioned to users. Signed-off-by: Paul Spooren <mail@aparcar.org>
2021-10-14 20:33:29 +02:00
* [OpenWrt Video](https://github.com/openwrt/video): Packages specifically
focused on display servers and clients (Xorg and Wayland).
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-07-16 10:19:37 +02:00
## Support Information
For a list of supported devices see the [OpenWrt Hardware Database](https://openwrt.org/supported_devices)
### Documentation
* [Quick Start Guide](https://openwrt.org/docs/guide-quick-start/start)
* [User Guide](https://openwrt.org/docs/guide-user/start)
* [Developer Documentation](https://openwrt.org/docs/guide-developer/start)
* [Technical Reference](https://openwrt.org/docs/techref/start)
### Support Community
* [Forum](https://forum.openwrt.org): For usage, projects, discussions and hardware advise.
README: switch from freenode to oftc We recently switched from freenode.net to oftc.net, reflect that in the README and update the links. Signed-off-by: Paul Spooren <mail@aparcar.org>
2021-06-13 00:38:30 +02:00
* [Support Chat](https://webchat.oftc.net/#openwrt): Channel `#openwrt` on **oftc.net**.
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-07-16 10:19:37 +02:00
### Developer Community
* [Bug Reports](https://bugs.openwrt.org): Report bugs in OpenWrt
* [Dev Mailing List](https://lists.openwrt.org/mailman/listinfo/openwrt-devel): Send patches
README: switch from freenode to oftc We recently switched from freenode.net to oftc.net, reflect that in the README and update the links. Signed-off-by: Paul Spooren <mail@aparcar.org>
2021-06-13 00:38:30 +02:00
* [Dev Chat](https://webchat.oftc.net/#openwrt-devel): Channel `#openwrt-devel` on **oftc.net**.
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-07-16 10:19:37 +02:00
## License
OpenWrt is licensed under GPL-2.0