Skip to content

Commit cd73690

Browse files
authored
README: add build instructions
1 parent 0143d7e commit cd73690

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

README.md

+37-9
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
<h1 align="center"><img src="http://i.imgur.com/pWWyVMO.png" alt="ctrmus icon"><br>ctrmus</h1>
2-
<p align="center">A music player for the Nintendo 3DS</p>
3-
<p align="center">Latest 3DSX/CIA/3DS download on <a href="https://github.com/deltabeard/ctrmus/releases">releases</a> page, using <a href="https://zxing.org/w/chart?cht=qr&chs=230x230&chld=L&choe=UTF-8&chl=https%3A%2F%2Fgithub.com%2Fdeltabeard%2Fctrmus%2Freleases%2Fdownload%2F0.4.12%2Fctrmus.cia">QR code</a>, or via titledb</p>
1+
<img align="right" alt="The ctrmus icon" src="meta/icon.png">
42

5-
### Features
3+
# ctrmus: a music player for the Nintendo 3DS
4+
5+
The latest 3DSX/CIA/3DS download can be found on the <a href="https://github.com/deltabeard/ctrmus/releases">releases</a> page, or by scanning <a href="https://zxing.org/w/chart?cht=qr&chs=230x230&chld=L&choe=UTF-8&chl=https%3A%2F%2Fgithub.com%2Fdeltabeard%2Fctrmus%2Freleases%2Fdownload%2F0.4.12%2Fctrmus.cia">this QR code</a>.
6+
7+
## Features
68
* Plays PCM WAV, AIFF, FLAC, Opus, Vorbis and MP3 files.
79
* Pause and play support.
810
* Plays music via headphones whilst system is closed.
911
* Ability to browse directories.
1012

11-
### Controls
13+
## Controls
1214
L+R or L+Up: Pause
1315

1416
L+B: Stop
@@ -25,15 +27,41 @@ Left & right = Move cursor skipping 13 files at a time.
2527

2628
Start: Exit
2729

28-
### Contributing
29-
Have a look at [CONTRIBUTING.md](https://github.com/deltabeard/ctrmus/blob/master/CONTRIBUTING.md) for some info and guidelines on contributing to the project.
30+
# Contributing
31+
32+
I very much welcome a pull request from anyone wanting to contribute! Be it a small spelling mistake, a bug fix or otherwise.
33+
34+
## Adding features
35+
Create an issue before you start work so that others know that your considering working on adding a feature or fixing a bug.
36+
37+
## Pull requests
38+
Please consider the following when making a pull request.
39+
* Commit messages should be clear.
40+
* Code style should be consistent.
41+
42+
If you're unsure whether to make a pull request, just make it. :smiley:
43+
44+
## Compiling
45+
46+
Build dependencies:
47+
- GNU Make
48+
- [makerom](https://github.com/3DSGuy/Project_CTR)
49+
- [bannertool](https://github.com/Steveice10/bannertool)
50+
- [devkitARM](https://devkitpro.org/wiki/Getting_Started), with the following packages installed:
51+
- libctru
52+
- 3ds-libmpg123
53+
- 3ds-libopus
54+
- 3ds-libopusfile
55+
- 3ds-libogg
56+
- 3ds-libvorbisidec
57+
- 3ds-libsidplay
58+
59+
To build, type `make` in the project folder.
3060

3161
### Planned features
3262
* Playlist support.
33-
* FFMPEG support.
3463
* Repeat and shuffle support.
3564
* Metadata support.
36-
* Gain support.
3765

3866
#### Notes
3967
Due to limitations in [ctrulib](https://github.com/smealum/ctrulib/issues/328), only ASCII characters are displayed correctly. Other characters will appear garbled, but functionality is not affected.

0 commit comments

Comments
 (0)