Skip to content

Commit 6e83abe

Browse files
authored
Formating
1 parent f122017 commit 6e83abe

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
This personal project is geared towards simple & essential use-cases for casual listeners using Bluetooth speakers, and missing their good-old Audio CDs playback...
55

66

7-
8-
<u>Main Features:</u>
7+
## <u>Main Features:</u>
98

109
- Audio-CD & web radio player
1110

@@ -17,28 +16,27 @@ This personal project is geared towards simple & essential use-cases for casual
1716

1817
- Headless operation, one-touch update
1918

20-
21-
22-
**tiny-radioCD** just relies on [MPD](https://www.musicpd.org/), ALSA and [bluez-alsa](https://github.com/Arkq/bluez-alsa/): it does not need to provide a graphical remote UI.
23-
Typically runs in 50MB of RAM on a low-cost PiZero device (135 MB rootf suitable for RAM-only operation).
24-
Check-out our minimalistic USB-powered [PiZeroWed-Mac mini](https://github.com/macmpi/tiny-radioCD/wiki)!
19+
\
20+
**tiny-radioCD** just relies on [MPD](https://www.musicpd.org/), ALSA and [bluez-alsa](https://github.com/Arkq/bluez-alsa/): it does not need to provide a graphical remote UI.\
21+
Typically runs in 50MB of RAM on a low-cost PiZero device (135 MB rootf suitable for RAM-only operation).\
22+
Check-out our minimalistic USB-powered [PiZeroWed-Mac mini](https://github.com/macmpi/tiny-radioCD/wiki/PiZeroWed-Mac-mini)!
2523

26-
Though mostly tested on Pi, it would run on any AlpineLinux supported platform (diskless/data/sys modes).
27-
Some ready-to-use images are available (Raspberry Pi armhf ram-only SD archive for instance).
28-
Customized installs can be included as simple addon-scripts (refer to available Pi example)
24+
Though mostly tested on Pi, it would run on any AlpineLinux supported platform (diskless/data/sys modes).\
25+
Some ready-to-use images are available (Raspberry Pi armhf ram-only SD archive for instance).\
26+
Customized installs can be included as simple addon-scripts (refer to available Pi example).
2927

3028

3129

32-
#### Seamless user operation:
30+
## Seamless user operation:
3331

3432
Player control (play/pause/etc...) is naturally operated with bluetooth speaker/headphone ***built-in keys***.
3533
Volume adjustment is set by speaker amplification stage.
3634

37-
***Multimedia bluetooth remotes*** are a perfect match too, allowing extended use-cases.
38-
Typically, the low-cost first-generation ***FireTV remote*** (& clone) works great (more info in [Wiki](https://github.com/macmpi/tiny-radioCD/wiki)).
35+
***Multimedia bluetooth remotes*** are a perfect match too, allowing extended use-cases.\
36+
Typically, the low-cost first-generation ***FireTV remote*** (& clone) works great (more info in [Wiki](https://github.com/macmpi/tiny-radioCD/wiki)).\
3937
***USB Keyboards*** with multimedia keys are supported too.
4038

41-
With network availability, any ***mpc client application*** can easily connect to **tiny-radioCD** player with Avahi discovery, and provide convenient user interface.
39+
With network availability, any ***mpc client application*** can easily connect to **tiny-radioCD** player with Avahi discovery, and provide convenient user interface.\
4240
[***MaximumMPD***](https://itunes.apple.com/gb/app/maximummpd/id1437096437?mt=8) on iOS is a good example of such clients, but there are many other available on any platforms.
4341

4442
***Hardware buttons*** (power on/off, eject) availability depend on actual devices running tiny-radioCD, and can easily be customized: i.e. on Pi, simple on/off push-button can be enabled with `dtoverlay=gpio-shutdown` in `usercfg.txt`.
@@ -47,29 +45,31 @@ With network availability, any ***mpc client application*** can easily connect t
4745

4846

4947

50-
#### Install procedure:
48+
## Install procedure:
5149

5250
If you don't use ready-made images, just do the following on your [AlpineLinux device](https://wiki.alpinelinux.org/wiki/Installation) with internet access:
53-
`cd /tmp`
54-
`wget -O tiny-radioCD.zip https://github.com/macmpi/tiny-radioCD/archive/master.zip`
55-
`unzip -oq tiny-radioCD.zip`
56-
`cd tiny-radioCD`
57-
`chmod +x setup-tiny-radioCD`
58-
`sudo ./setup-tiny-radioCD`
59-
60-
After install, bluetooth speaker pairing (and eventual remote command pairing) may be done under console or ssh (alternatively, check *[easy-setup](https://github.com/macmpi/tiny-radioCD/wiki)* section in Wiki):
61-
`sudo bluetoothctl` After a <u>scan</u>, make sure you <u>pair</u>, <u>connect</u> and <u>trust</u> your bluetooth devices.
62-
Take note of your speaker MAC address `XX:XX:XX:XX:XX:XX` in your home directory with:
63-
`printf "XX:XX:XX:XX:XX:XX" > myspeaker`
64-
Then finish speaker setup with the below command:
65-
`sudo set-speaker myspeaker` this command may greatly help switching between paired speakers later.
51+
```
52+
cd /tmp
53+
wget -O tiny-radioCD.zip https://github.com/macmpi/tiny-radioCD/archive/master.zip
54+
unzip -oq tiny-radioCD.zip
55+
cd tiny-radioCD
56+
chmod +x setup-tiny-radioCD
57+
sudo ./setup-tiny-radioCD
58+
```
59+
60+
After install, bluetooth speaker pairing (and eventual remote command pairing) may be done under console or ssh (alternatively, check *[easy-setup](https://github.com/macmpi/tiny-radioCD/wiki)* section in Wiki):\
61+
`sudo bluetoothctl` After a <u>scan</u>, make sure you <u>pair</u>, <u>connect</u> and <u>trust</u> your bluetooth devices.\
62+
Take note of your speaker MAC address `XX:XX:XX:XX:XX:XX` in your home directory with:\
63+
`printf "XX:XX:XX:XX:XX:XX" > myspeaker`\
64+
Then finish speaker setup with the below command:\
65+
`sudo set-speaker myspeaker` this command may greatly help switching between paired speakers later.\
6666
(if running in diskless mode, do not forget to commit changes after pairing: `lbu commit -d`)
6767

6868
Reboot to take advantage of your new **tiny-radioCD**!
6969

7070

7171

72-
#### Versions history:
72+
## Versions history:
7373

7474
```
7575
0.5: (May 17th 2020)
@@ -78,7 +78,7 @@ Reboot to take advantage of your new **tiny-radioCD**!
7878

7979

8080

81-
#### Contributions:
81+
## Contributions:
8282

8383
Contributions are welcome in `dev` branch.
8484

0 commit comments

Comments
 (0)