README.md 4.2 KB
Newer Older
1
# Shortwave
Felix Häcker's avatar
Felix Häcker committed
2
Find and listen to internet radio stations
Felix Häcker's avatar
Felix Häcker committed
3

Felix Häcker's avatar
Felix Häcker committed
4 5 6 7 8
<p align="center">
  <img src="data/screenshots/1.png"/>
  <img src="data/screenshots/4.png"/>
</p>

Felix Häcker's avatar
Felix Häcker committed
9

Felix Häcker's avatar
Felix Häcker committed
10 11
## Getting in Touch
If you have any questions regarding the use or development of Shortwave,
Felix Häcker's avatar
Felix Häcker committed
12
want to discuss design or simply hang out, please join us on our [#shortwave:gnome.org](https://matrix.to/#/#shortwave:matrix.org) channel.
Felix Häcker's avatar
Felix Häcker committed
13

Felix Häcker's avatar
Felix Häcker committed
14
## FAQ
Felix Häcker's avatar
Felix Häcker committed
15 16 17 18 19 20 21
- **Why its called 'Shortwave'?**

    Shortwave signals have a very long range because of their very good reflection properties. 
Due to their long range, they can be received almost anywhere in the world. 
The same applies to Internet radio stations, which can also be received almost anywhere in the world.
That's why we decided to call the project 'Shortwave', because internet radio stations and shortwave radio stations share many characteristics.

Felix Häcker's avatar
Felix Häcker committed
22 23
    If you want to know more about the naming process, you should read this [blog post](https://blogs.gnome.org/tbernard/2019/04/26/naming-your-app/)

Felix Häcker's avatar
Felix Häcker committed
24
- **Why I cannot edit stations anymore?**
Felix Häcker's avatar
Felix Häcker committed
25

Felix Häcker's avatar
Felix Häcker committed
26
    The edit feature is disabled because of vandalism. I cannot change this. [More information here](http://www.radio-browser.info/gui/#/) and [here](https://github.com/segler-alex/radiobrowser-api/issues/39)
Felix Häcker's avatar
Felix Häcker committed
27

Felix Häcker's avatar
Felix Häcker committed
28 29 30
- **Is Shortwave compatible with the Librem 5 / PinePhone?**

    Yes! We use the awesome [libadwaita](https://gitlab.gnome.org/GNOME/libadwaita) library to make the interface adaptive. The easiest way to get it on your phone is using the Flatpak package. [Flathub](https://flathub.org/apps/details/de.haeckerfelix.Shortwave) provides aarch64 packages.
Felix Häcker's avatar
Felix Häcker committed
31

Felix Häcker's avatar
Felix Häcker committed
32 33
![Adaptive Screenshot 1](data/screenshots/5.png)
![Adaptive Screenshot 2](data/screenshots/6.png)
Felix Häcker's avatar
Felix Häcker committed
34

Felix Häcker's avatar
Felix Häcker committed
35
- **Which database does Shortwave use?**
Felix Häcker's avatar
Felix Häcker committed
36

David Heidelberg's avatar
David Heidelberg committed
37
    [radio-browser.info](http://www.radio-browser.info/gui/#/). It's a community database. Everybody can add information.
38 39 40
    
- **How I can get debug information?**
    Run Shortwave using `RUST_BACKTRACE=1 RUST_LOG=shortwave=debug flatpak run de.haeckerfelix.Shortwave` (`.Devel`).
Felix Häcker's avatar
Felix Häcker committed
41

Felix Häcker's avatar
Felix Häcker committed
42 43 44 45 46 47
## Translations
Translation of this project takes place on the GNOME translation platform,
[Damned Lies](https://l10n.gnome.org/module/shortwave). For further
information on how to join a language team, or even to create one, please see
[GNOME Translation Project wiki page](https://wiki.gnome.org/TranslationProject).

Felix Häcker's avatar
Felix Häcker committed
48
## Flatpak builds
Felix Häcker's avatar
Felix Häcker committed
49
The recommended way of installing Shortwave is using the Flatpak package. If you don't have Flatpak installed yet, you can get it from [here](https://flatpak.org/setup/).
Felix Häcker's avatar
Felix Häcker committed
50

Felix Häcker's avatar
Felix Häcker committed
51 52 53 54 55 56 57 58
#### Stable builds
You can install stable builds of Shortwave from Flathub by using this command:

`flatpak install https://flathub.org/repo/appstream/de.haeckerfelix.Shortwave.flatpakref`

<a href="https://flathub.org/apps/details/de.haeckerfelix.Shortwave"><img src="https://flathub.org/assets/badges/flathub-badge-en.png" width="200"/></a>


Felix Häcker's avatar
Felix Häcker committed
59
#### Nightly builds
Felix Häcker's avatar
Felix Häcker committed
60
You can install nightly builds of Shortwave by using this command:
Felix Häcker's avatar
Felix Häcker committed
61

Felix Häcker's avatar
Felix Häcker committed
62
`flatpak install https://haeckerfelix.de/~repo/shortwave.flatpakref`
Felix Häcker's avatar
Felix Häcker committed
63

Felix Häcker's avatar
Felix Häcker committed
64
More information are [here available](https://haeckerfelix.de/~repo/shortwave)! The repository is automatically updated every day. You can update to the latest nightly by running `flatpak update`!
65

Felix Häcker's avatar
Felix Häcker committed
66
## Building
Felix Häcker's avatar
Felix Häcker committed
67 68
### Building with Flatpak + GNOME Builder
Shortwave can be built and run with [GNOME Builder](https://wiki.gnome.org/Apps/Builder) >= 3.28.
Felix Häcker's avatar
Felix Häcker committed
69 70
Just clone the repo and hit the run button!

Felix Häcker's avatar
Felix Häcker committed
71
You can get Builder from [here](https://wiki.gnome.org/Apps/Builder/Downloads), and the Rust Nightly Flatpak SDK (if necessary) from [here](https://haeckerfelix.de/~repo/)
Felix Häcker's avatar
Felix Häcker committed
72 73 74 75 76 77 78 79 80

### Building it manually
1. `git clone https://gitlab.gnome.org/World/Shortwave.git`
2. `cd Shortwave`
3. `meson --prefix=/usr build`
4. `ninja -C build`
5. `sudo ninja -C build install`

You need following dependencies to build Shortwave:
81
- Rust 1.48 or later
Julian Hofer's avatar
Julian Hofer committed
82
- GTK 4
83
- Gstreamer 1.16 or later
84 85
- Sqlite3
- OpenSSL
Julian Hofer's avatar
Julian Hofer committed
86
- [libadwaita](https://gitlab.gnome.org/GNOME/libadwaita)
Felix Häcker's avatar
Felix Häcker committed
87 88 89
- [Meson Buildsystem](https://mesonbuild.com/)

If you need help to build Shortwave, please don't hesitate to ask [here](https://matrix.to/#/#shortwave:matrix.org)!
Felix Häcker's avatar
Felix Häcker committed
90

Felix Häcker's avatar
Felix Häcker committed
91
## Code Of Conduct
louib's avatar
louib committed
92
We follow the [GNOME Code of Conduct](/CODE_OF_CONDUCT.md).
Felix Häcker's avatar
Felix Häcker committed
93
All communications in project spaces are expected to follow it.