Difuse/difos
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
difos/README.md

72 lines
2.7 KiB
Markdown
Raw Normal View History

README: update
2023-11-28 12:42:15 +00:00
<picture>
README: fix logo color
2023-11-28 12:43:23 +00:00
<source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/pR97tbF.png">
<source media="(prefers-color-scheme: light)" srcset="https://i.imgur.com/queGRtS.png">
<img alt="DifOS - Logo" src="https://i.imgur.com/queGRtS.png">
README: update
2023-11-28 12:42:15 +00:00
</picture>
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 08:19:37 +00:00
README: update
2023-11-28 12:42:15 +00:00
[![Build Status](https://ci.difuse.io/buildStatus/icon?job=DifOS)](https://ci.difuse.io/job/DifOS/)
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 08:19:37 +00:00
README: update
2023-11-28 12:42:15 +00:00
DifOS is part of the Difuse Project, firmware that is based on OpenWrt and is available for use on DMSBG devices.
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 08:19:37 +00:00
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 08:57:46 +00:00
## Download
README: update
2023-11-28 12:42:15 +00:00
Built firmware is available for download [here](https://gin.difuse.io/downloads).
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 08:57:46 +00:00
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 08:19:37 +00:00
## 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
README: update
2023-11-28 12:42:15 +00:00
[Build System Setup](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem) is pretty much identical to that of OpenWRT. Below given are the common packages required to build the firmware.
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 08:19:37 +00:00
```
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 07:01:08 +00: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-08 23:07:18 +00: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 08:19:37 +00: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/
README: update
2023-11-28 12:42:15 +00:00
3. Run `mv dmsbg100.config .config && make defconfig` to use the default
configuration for the DMSBG100 device.
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 08:19:37 +00:00
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.
README: update
2023-11-28 12:42:15 +00:00
* [LuCI Web Interface](https://github.com/DifuseHQ/luci): Modern and modular
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 08:19:37 +00:00
interface to control the device via a web browser.
README: update
2023-11-28 12:42:15 +00:00
* [DifOS Packages](https://github.com/DifuseHQ/packages): Community repository
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 08:19:37 +00:00
of ported packages.
README: update
2023-11-28 12:42:15 +00:00
* [DifOS Routing](https://github.com/DifuseHQ/routing): Packages specifically
focused on routing.
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 18:33:29 +00:00
README: update
2023-11-28 12:42:15 +00:00
* [DifOS Telephony](https://github.com/DifuseHQ/telephony): Packages specifically
focused on telephony.
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 08:19:37 +00:00
### Support Community
README: update
2023-11-28 12:42:15 +00:00
* [Forum](https://forum.difuse.io): For usage, projects, discussions and hardware advice.
* [Support Chat](https://discord.gg/u6RupFDMp9): Discord server for support and general discussion.
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 08:19:37 +00:00
## License
README: update
2023-11-28 12:42:15 +00:00
DifOS is licensed under GPL-2.0
Reference in a new issue Copy permalink