Rockbox open source high quality audio player as a Music Player Daemon
mpris
rockbox
mpd
libadwaita
audio
rust
zig
deno
Merge pull request #77 from j03-dev/build_instruction
update README
authored by
Tsiry Sandratraina
and committed by
GitHub
b4aba62b
f92a4d10
+42
-4
+42
-4
README.md
+42
-4
README.md
···
46
46
tsiry/rockbox:latest
47
47
```
48
48
49
+
## Requirements
50
+
49
51
Run the following commands to build the project:
52
+
Before building the project, you need to install the necessary dependencies for your operating system.
53
+
54
+
### On Ubuntu/Debian
55
+
56
+
```bash
57
+
sudo apt-get install libusb-dev libsdl1.2-dev libfreetype6-dev libunwind-dev zip protobuf-compiler cmake
58
+
```
59
+
60
+
### On Fedora40/41:
50
61
51
62
```sh
52
-
sudo apt-get install libusb-dev libsdl1.2-dev libfreetype6-dev libunwind-dev zip protobuf-compiler cmake
63
+
sudo dnf install libusb1-devel SDL-devel freetype-devel libunwind-devel zip protobuf-compiler cmake
64
+
sudo ln -s /lib64/libusb-1.0.so /usr/lib64/libusb.so
65
+
```
66
+
67
+
### Build Instructions
68
+
69
+
1. Clone the repository
70
+
71
+
```sh
72
+
git clone https://github.com/tsirysndr/rockbox-zig.git
73
+
git submodule update --init --recursive
74
+
```
75
+
76
+
2. Navigate to the project directory
77
+
78
+
```sh
79
+
cd rockbox-zig
80
+
```
81
+
82
+
3. Build the webui
83
+
```sh
84
+
cd webui/rockbox
85
+
deno install
86
+
deno run build
87
+
```
88
+
89
+
4. Run the following command to build the project
90
+
91
+
```sh
53
92
mkdir -p build && cd build
54
93
../tools/configure --target=sdlapp --type=N --lcdwidth=320 --lcdheight=240 --prefix=$HOME/.local
55
94
make zig
···
69
108
70
109
- `Linux`: intel: [rockbox_2024.12.25_x86_64-linux.tar.gz](https://github.com/tsirysndr/rockbox-zig/releases/download/2024.12.25/rockbox_2024.12.25_x86_64-linux.tar.gz) arm64: [rockbox_2024.12.25_aarch64-linux.tar.gz](https://github.com/tsirysndr/rockbox-zig/releases/download/2024.12.25/rockbox_2024.12.25_aarch64-linux.tar.gz)
71
110
72
-
73
111
## ✨ Features
74
112
75
113
- [x] Zig Build System
···
100
138
## 🧑🔬 Architecture
101
139
102
140
103
-
141
+
104
142
## 📚 GraphQL API
105
143
106
144
Open [http://localhost:6062/graphiql](http://localhost:6062/graphiql) in your browser.
···
108
146
<p style="margin-top: 20px; margin-bottom: 20px;">
109
147
<img src="./docs/graphql.png" width="100%" />
110
148
</p>
111
-
149
+
112
150
## 📚 HTTP API
113
151
114
152
Open [http://localhost:6063](http://localhost:6063) in your browser.