Skip to content

Commit 4941900

Browse files
author
technosf
committed
MD linting clean up.
1 parent c713c93 commit 4941900

File tree

5 files changed

+42
-44
lines changed

5 files changed

+42
-44
lines changed

NOTES.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@
33
## GSettings
44

55
Use gsettings command to monitor or manipulate settings.
6-
See https://askubuntu.com/questions/249887/gconf-dconf-gsettings-and-the-relationship-between-them
7-
6+
See <https://askubuntu.com/questions/249887/gconf-dconf-gsettings-and-the-relationship-between-them>

PACKAGING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,46 @@
66

77
The desktop file must be validated using this command:
88

9-
```
10-
$ desktop-file-validate [name-of-desktop-file]
9+
```bash
10+
desktop-file-validate [name-of-desktop-file]
1111
```
1212

1313
### AppData
1414

1515
The AppData.xml must be validated using this command:
1616

17-
```
18-
$ flatpak run org.freedesktop.appstream-glib validate [path-to-xml]
17+
```bash
18+
flatpak run org.freedesktop.appstream-glib validate [path-to-xml]
1919

2020
```
2121

2222
### Test different languages
2323

24-
```
25-
$ LANGUAGE=de_DE ./com.github.louis77.tuner
24+
```bash
25+
LANGUAGE=de_DE ./com.github.louis77.tuner
2626

2727
```
2828

2929
## Flatpak
3030

3131
The flathub build manifest can be found here:
32-
https://github.com/louis77/flathub/tree/com.github.louis77.tuner
32+
<https://github.com/louis77/flathub/tree/com.github.louis77.tuner>
3333

3434
- [ ] Move over to a non-elementary base image
3535

3636
## Pacstall
3737

3838
Tuner is in the pacstall repo with the lastest release (1.3.1):
39-
https://github.com/louis77/pacstall-programs
39+
<https://github.com/louis77/pacstall-programs>
4040

4141
## Dev Tricks
4242

4343
### See Debug Log
4444

45-
https://docs.elementary.io/develop/writing-apps/logging
45+
<https://docs.elementary.io/develop/writing-apps/logging>
4646

4747
```bash
48-
$ G_MESSAGES_DEBUG=all ./com.github.louis77.tuner
48+
G_MESSAGES_DEBUG=all ./com.github.louis77.tuner
4949
```
5050

5151
### Available elementary Icons
@@ -60,4 +60,4 @@ sudo /usr/bin/glib-compile-schemas /usr/share/glib-2.0/schemas/
6060

6161
## Release Checklist
6262

63-
- [ ] Create Release Tag in AppData
63+
- [ ] Create Release Tag in AppData

README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
# ![icon](docs/logo_01.png) Tuner [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![Translation status](https://hosted.weblate.org/widgets/tuner/-/tuner-ui/svg-badge.svg)](https://hosted.weblate.org/engage/tuner/)
22

33
## Minimalist radio station player - V2
4+
45
Discover and Listen to your favourite internet radio stations.
56

67
![Screenshot 01](docs/Tuner_2.0_discover.png?raw=true)
78

8-
## Contributors wanted!
9+
## Contributors wanted
910

10-
I've started `Tuner` in May 2020 when COVID-19 began to change our lives and provided me with some time to finally learn things that I couldn't during my life as a professional developer.
11+
I've started `Tuner` in May 2020 when COVID-19 began to change our lives and provided me with some time to finally learn things that I couldn't during my life as a professional developer.
1112

1213
I moved from macOS to Linux as a daily driver, learned a little about Linux programming, and chose Vala as the language for Tuner. At the time I was running elementary OS, and they have excellent documentation for beginning developers on how to build nice-looking apps for elementary. That helped me a lot to get started with all the new stuff.
1314

14-
At the time, I never expected `Tuner` to be installed by the thousands on other great distros, like Arch, MX Linux, Ubuntu, Fedora. In August 2020, I released `Tuner` as a Flatpak app, and it was installed over 18.000 times on Flathub alone ever since! Users began to send me their appreciations but also bug reports and feature requests. Some friendly contributors made Tuner available on MX Linux and Arch AUR repos.
15+
At the time, I never expected `Tuner` to be installed by the thousands on other great distros, like Arch, MX Linux, Ubuntu, Fedora. In August 2020, I released `Tuner` as a Flatpak app, and it was installed over 18.000 times on Flathub alone ever since! Users began to send me their appreciations but also bug reports and feature requests. Some friendly contributors made Tuner available on MX Linux and Arch AUR repos.
1516

16-
Maybe it was around this time when I started to feel not only the euphoria that comes with Open Source projects but also the weight of responsibility. I feared to move on because I didn't want to break things, so *I* took a break :-).
17+
Maybe it was around this time when I started to feel not only the euphoria that comes with Open Source projects but also the weight of responsibility. I feared to move on because I didn't want to break things, so *I* took a break :-).
1718

18-
Yet, users keep sending bug reports and feature requests. I want `Tuner` to live on and be the best tiny internet radio receiver for the Linux environment.
19+
Yet, users keep sending bug reports and feature requests. I want `Tuner` to live on and be the best tiny internet radio receiver for the Linux environment.
1920

2021
### You can help translate Tuner into your language
2122

@@ -25,7 +26,6 @@ Tuner translations are now hosted on [Weblate](https://hosted.weblate.org/engage
2526

2627
Thanks to the Weblate team for generously hosting Tuner for free.
2728

28-
2929
**Would you be interested in joining the project as a developer or package maintainer?**
3030

3131
Things I need help with:
@@ -43,46 +43,48 @@ Things I need help with:
4343
### Flathub
4444

4545
Tuner is primarily available as a Flatpak on Flathub:
46-
https://flathub.org/apps/details/com.github.louis77.tuner
47-
46+
<https://flathub.org/apps/details/com.github.louis77.tuner>
4847

4948
### Local Build
5049

5150
Build Tuner localy with the [development doc](DEVELOP.md).
5251

53-
5452
### Other Places
53+
5554
Other packed versions of Tuner are available, but are maintained outside of Tuner itself: Versions may be out of date.
5655

5756
#### elementary OS
5857

5958
Install Tuner via elementary's App store:
60-
https://appcenter.elementary.io/com.github.louis77.tuner
59+
<https://appcenter.elementary.io/com.github.louis77.tuner>
6160

6261
#### Arch Linux / AUR
62+
6363
Arch-based GNU/Linux users can find `Tuner` under the name [tuner-git](https://aur.archlinux.org/packages/tuner-git/) in the **AUR**:
6464

65-
```sh
66-
$ yay -S tuner-git
65+
```bash
66+
yay -S tuner-git
6767
```
68+
6869
Thanks to [@btd1377](https://github.com/btd1337) for supporting Tuner on Arch Linux!
6970

7071
#### MX Linux
72+
7173
MX Linux users can find `Tuner` by using the MX Package Installer (currently under the MX Test Repo tab for MX-19 and the Stable Repo for MX-21)
7274

7375
Thanks to SwampRabbit for packaging Tuner for MX Linux!
7476

7577
#### Pacstall
78+
7679
Pacstall is a totally new package manager for Ubuntu that provides an AUR-like community-driven repo for package builds. If you already use `pacstall` you can install Tuner:
7780

78-
```sh
79-
$ pacstall -I tuner
81+
```bash
82+
pacstall -I tuner
8083
```
8184

8285
If you have Ubuntu and want a clean build of Tuner on your system, consider using `pacstall` instead of Flatpak if you don't feat beta software. Get `pacstall` here:
8386

84-
https://pacstall.dev
85-
87+
<https://pacstall.dev>
8688

8789
## Motivation
8890

@@ -108,42 +110,40 @@ While I hacked on this App, I discovered so many cool and new stations, which ma
108110

109111
## Environment Variables
110112

111-
* `TUNER_API` - a `:` separated list of API servers to read from, e.g.
112-
* `export TUNER_API="de1.api.radio-browser.info:nl1.api.radio-browser.info"; com.github.louis77.tuner`
113-
113+
`TUNER_API` - a `:` separated list of API servers to read from, e.g.
114+
_ `export TUNER_API="de1.api.radio-browser.info:nl1.api.radio-browser.info"; com.github.louis77.tuner`
114115

115116
## Build, Maintance and Development of Tuner
116117

117118
Building, developing and maintianing **Tuner** is detailed seperately and in detail in the [DEVELOP](DEVELOP.md) markdown.
118119

119-
120-
## Support
120+
## Support
121121

122122
Feature request, observations and Issues can be documented with tickets on [Github](https://github.com/louis77/tuner/issues)
123123

124-
125124
### Known Issues
126125

127-
#### If AAC/AAC+ streams don't play (found on Elementary OS 6) install the following dependency:
128-
```sh
129-
$ sudo apt install gstreamer1.0-libav
126+
#### If AAC/AAC+ streams don't play (found on Elementary OS 6) install the following dependency
127+
128+
```bash
129+
sudo apt install gstreamer1.0-libav
130130
```
131131

132132
#### 'Failed to load module "xapp-gtk3-module"'
133+
133134
Running Tuner from the CLI with `flatpak run com.github.louis77.tuner` may produce a message like the following:
134135

135136
`Gtk-Message: 10:01:00.561: Failed to load module "xapp-gtk3-module"`
136137

137138
This relates to Gtk looking for Xapp (which isn't used by Tuner) and can be ignored.
138139

139-
140140
## Credits
141141

142-
- [technosf](https://github.com/technosf) (_Me!_) Louis has been gracious enough to let me rewrite a swarthe of Tuner and create v2
142+
- [technosf](https://github.com/technosf) (*Me!*) Louis has been gracious enough to let me rewrite a swarthe of Tuner and create v2
143143
- [faleksandar.com](https://faleksandar.com/) for icons and colors
144144
- [faleksandar.com](https://faleksandar.com/) for icons and colors
145145
- [@NathanBnm](https://github.com/NathanBnm) - French translation
146-
- [@DevAlien](https://github.com/DevAlien) - Italian translation
146+
- [@DevAlien](https://github.com/DevAlien) - Italian translation
147147
- [@albanobattistella](https://github.com/albanobattistella) - Italian translation
148148
- [@Vistaus](https://github.com/Vistaus) - Dutch translation
149149
- [@safak45x](https://github.com/safak45x) - Turkish translation
@@ -162,4 +162,3 @@ not have been possible.
162162

163163
Tuner uses the community-driven radio station catalog radio-browser.info. Tuner
164164
is not responsible for the stations shown or the actual streaming audio content.
165-

com.github.louis77.tuner.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ finish-args:
2626
- "--talk-name=org.freedesktop.Notifications"
2727
- "--own-name=org.mpris.MediaPlayer2.Tuner"
2828
- "--env=PATH=/usr/bin:/app/bin:/app/vala/bin"
29-
- "--env=add-ld-path=/app/vala/lib:/app/lib:/lib"
29+
# - "--env=add-ld-path=/app/vala/lib:/app/lib:/lib"
3030

3131
cleanup:
3232
- "/include"

meson.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
project (
33
'com.github.louis77.tuner',
44
'vala', 'c',
5-
version: '2.0.1',
5+
version: '2.0.2',
66
meson_version: '>= 0.60.0',
77
)
88

0 commit comments

Comments
 (0)