Skip to content

Commit f74d9c4

Browse files
committed
Build and installing sections.
1 parent 20c699d commit f74d9c4

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,33 @@ designed to be simple and fast, but also powerful and fully automated.
3131
Currently **muso** supports MP3 and FLAC, but in the future it's planned to
3232
support most codecs for audio.
3333

34+
## Building
35+
To build **muso** yourself you need at least Rust 1.41. If you aren't going
36+
to install it using a package manager you should build **muso** with feature
37+
`standalone` activated, for example:
38+
39+
```bash
40+
cargo build --features standalone --release
41+
```
42+
43+
The standalone feature include contents of [service](share/muso.service) and
44+
[config](share/config.toml) in binary, so **muso** can create these files by itself.
45+
46+
## Installing
47+
To install from source using cargo (installed bin is in `$HOME/.cargo/bin`)
48+
you can do the following:
49+
50+
```bash
51+
cargo install --path . --features standalone
52+
```
53+
54+
Package is also [available on the AUR](https://aur.archlinux.org/packages/muso)
55+
for Arch Linux, just install it using your preferred method, for example:
56+
57+
```bash
58+
yay -S muso
59+
```
60+
3461
## Concepts
3562

3663
### Format string
@@ -140,6 +167,7 @@ automatically on boot. Service file should be run on user level (`systemd
140167
--user`). The easiest way to copy the service file is running **muso** with
141168
`--copy-service`, that's all.
142169

170+
143171
## License
144172

145173
GNU General Public License v3.0

0 commit comments

Comments
 (0)