README: add build instructions
This commit is contained in:
46
README.md
46
README.md
@@ -1,14 +1,16 @@
|
||||
<h1 align="center"><img src="http://i.imgur.com/pWWyVMO.png" alt="ctrmus icon"><br>ctrmus</h1>
|
||||
<p align="center">A music player for the Nintendo 3DS</p>
|
||||
<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>
|
||||
<img align="right" alt="The ctrmus icon" src="meta/icon.png">
|
||||
|
||||
### Features
|
||||
# ctrmus: a music player for the Nintendo 3DS
|
||||
|
||||
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>.
|
||||
|
||||
## Features
|
||||
* Plays PCM WAV, AIFF, FLAC, Opus, Vorbis and MP3 files.
|
||||
* Pause and play support.
|
||||
* Plays music via headphones whilst system is closed.
|
||||
* Ability to browse directories.
|
||||
|
||||
### Controls
|
||||
## Controls
|
||||
L+R or L+Up: Pause
|
||||
|
||||
L+B: Stop
|
||||
@@ -25,15 +27,41 @@ Left & right = Move cursor skipping 13 files at a time.
|
||||
|
||||
Start: Exit
|
||||
|
||||
### Contributing
|
||||
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.
|
||||
# Contributing
|
||||
|
||||
I very much welcome a pull request from anyone wanting to contribute! Be it a small spelling mistake, a bug fix or otherwise.
|
||||
|
||||
## Adding features
|
||||
Create an issue before you start work so that others know that your considering working on adding a feature or fixing a bug.
|
||||
|
||||
## Pull requests
|
||||
Please consider the following when making a pull request.
|
||||
* Commit messages should be clear.
|
||||
* Code style should be consistent.
|
||||
|
||||
If you're unsure whether to make a pull request, just make it. :smiley:
|
||||
|
||||
## Compiling
|
||||
|
||||
Build dependencies:
|
||||
- GNU Make
|
||||
- [makerom](https://github.com/3DSGuy/Project_CTR)
|
||||
- [bannertool](https://github.com/Steveice10/bannertool)
|
||||
- [devkitARM](https://devkitpro.org/wiki/Getting_Started), with the following packages installed:
|
||||
- libctru
|
||||
- 3ds-libmpg123
|
||||
- 3ds-libopus
|
||||
- 3ds-libopusfile
|
||||
- 3ds-libogg
|
||||
- 3ds-libvorbisidec
|
||||
- 3ds-libsidplay
|
||||
|
||||
To build, type `make` in the project folder.
|
||||
|
||||
### Planned features
|
||||
* Playlist support.
|
||||
* FFMPEG support.
|
||||
* Repeat and shuffle support.
|
||||
* Metadata support.
|
||||
* Gain support.
|
||||
|
||||
#### Notes
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user