Skip to content

Update README.md - split and update the Building and Installation part#3427

Open
serialrf433 wants to merge 1 commit intomerbanan:masterfrom
serialrf433:patch-1
Open

Update README.md - split and update the Building and Installation part#3427
serialrf433 wants to merge 1 commit intomerbanan:masterfrom
serialrf433:patch-1

Conversation

@serialrf433
Copy link

Many things have changed in over 5 years. Lets update the readme. Every supported Debian release these days have the package available. apt-get is now just apt. CPU architectures like RISC-V are more common now. ESP32 devices with build in LoRa chipsets exist that can be used for FSK and OOK decoding, and much more.

Many things have changed in over 5 years. Lets update the readme. Every supported Debian release these days have the package available. apt-get is now just apt. CPU architectures like RISC-V are more common now. ESP32 devices with build in LoRa chipsets exist that can be used for FSK and OOK decoding, and much more.
@zuckschwerdt
Copy link
Collaborator

Work on our docs is welcome. Thanks!

About the contents, we don't know of FreeBSD users (of NetBSD we know), and I think we also dont't know about or test i386, ppc64el, riscv64, s390x.

Not sure if we want to feature OpenWrt specifically. An ESP32 note should be bolder, like "for ESP32 devices there is the rtl_433_ESP spin off."

I hope Debian and Ubuntu will be familiar to users of derived distros. Naming Trisquel, PureOS, Kali seems random.

@serialrf433
Copy link
Author

FreeBSD was named before in the doc. I left it there. I did the check if its still available and it is. The maintainer of the rtl-433 package for FreeBSD is rodrigo@freebsd.org . The availability of rtl-433 in FreeBSD is listed in https://www.freshports.org/comms/rtl-433, in https://repology.org/project/rtl-433/versions and in https://pkgs.org/download/rtl-433 .

i386 - its the most basic 32bit architecture on x86. The listed i686 before was like if you name x86_64_v3 instead of the basic x86_64. The i386 package is stable in debian: https://packages.debian.org/search?keywords=rtl-433&searchon=names&suite=stable&section=all

Now you also know about the source of the CPU architecture rtl_433 is listed to be working and stable. Debian is conservative and is testing all the things before they list them as stable.

ppc64el and riscv64 are also more common. Especially riscv64 (64bit RISC-V) is even available on some modern laptops.
I would just use the current debian stable cpu architecture list to show off how many different cpu architectures are supported and put at the end the word others to show even further flexibility. ESP32, MIPS and others like that are proven to be working in OpenWrt.

I added OpenWrt because routers as a target was listed in there before. Also the rtl-433 package is just available to install with opkg: https://repology.org/project/rtl-433/versions
It is highly practical to run additional things on your already 24/7 running device you use for internet access purpose.

ESP32 is sort of a hardware architecture. I named it in general and linked to a project rtl_433 is most commonly used to run on ESP32. Also OpenWrt is just the most common tool to run rtl_433 on your router instead of building your own Linux OS and putting it on there.

I took the other Debian-like distro from here https://repology.org/project/rtl-433/versions (ctrl+f for debian and look at the maintainer). The idea behind that was to list more of them to show the wide availability of rtl_433 also in not as common used distro and on the other side show to the people some other options they could use. Just naming ubuntu as the only debian based distro is not fair and correct these days.

I had spend time into thinking in detail how to change the documentation at the page. I hope explaining it here more in detail helps to merge it.

@zuckschwerdt zuckschwerdt force-pushed the master branch 3 times, most recently from 2e725ca to 5e76779 Compare December 29, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants