Skip to content
This repository was archived by the owner on Nov 9, 2024. It is now read-only.

Commit b43f8ee

Browse files
committed
Update README.md
1 parent db2c9f4 commit b43f8ee

1 file changed

Lines changed: 50 additions & 3 deletions

File tree

README.md

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,60 @@ GUI and TUI music player with support for multiple streaming services.
1515
| Spotify | Audio is downloaded with youtube-dl's `ytsearch:` feature |
1616
| SoundCloud | |
1717

18-
## Dependencies
19-
* DUB and D compiler (prefarably LDC2)
18+
## Building and installing
19+
### Installing
20+
xp is available on the AUR, to install it, use the following command:
21+
```sh
22+
yay -S xp-git yt-dlp yt-dlp-drop-in
23+
```
24+
To run it, run the following command in the terminal:
25+
```sh
26+
# For terminal interface
27+
xp tui
28+
29+
# For gtk4 interface
30+
xp
31+
```
32+
For other platforms, refer to the build instructions below.
33+
34+
### Building
35+
The following dependencies are required for building:
36+
* DUB and D compiler (prefarably LDC2)
37+
38+
The following runtime dependencies are required:
2039
* SDL2_mixer
2140
* gtk4 and libadwaita
2241
* yt-dlp/youtube-dl
2342
* ffmpeg or avconv
2443
* taglib (taglib_c)
2544
* dbus
2645
* sqlite3
27-
* libmodest
46+
* modest
47+
48+
Commands to install these packages for select platforms:
49+
```sh
50+
# Arch Linux
51+
52+
# Build dependencies
53+
sudo pacman -S dub ldc
54+
# Runtime dependencies
55+
sudo pacman -S liblphobos dbus sdl2_mixer gtk4 libadwaita youtube-dl ffmpeg taglib dbus sqlite3 modest
56+
```
57+
<!--
58+
currently not supported due to lack of modest
59+
```sh
60+
# Ubuntu 22.04
61+
62+
# Build
63+
sudo apt-get install ldc dub
64+
# Runtime
65+
sudo apt-get install libphobos2-ldc-shared98 libsdl2-mixer-2.0-0 libgtk-4-1 libadwaita-1-0 ffmpeg youtube-dl libtag1v5 sqlite dbus
66+
```
67+
-->
68+
Building the program:
69+
```sh
70+
git clone https://github.com/Ryhon0/xp
71+
cd xp
72+
dub build -b release
73+
strip xp
74+
```

0 commit comments

Comments
 (0)