The new file is written in the Gitlab markdown language. I also update the content to match how things are done now that we use CMake. Implements #85: Update README Signed-off-by: Anna Schumaker <Anna@NoWheyCreamery.com>
|6 years ago|
|core||6 years ago|
|gui||6 years ago|
|include||6 years ago|
|share||6 years ago|
|tests||6 years ago|
|.gitattributes||8 years ago|
|.gitignore||6 years ago|
|.gitlab-ci.yml||6 years ago|
|CHANGELOG||6 years ago|
|CMakeLists.txt||6 years ago|
|CTestCustom.cmake||6 years ago|
|LICENSE||9 years ago|
|PKGBUILD||6 years ago|
|README.md||6 years ago|
|TODO||6 years ago|
|ocarina.supp||6 years ago|
Ocarina is a simple GTK+ and GStreamer based music player written to let you listen to your music without getting in the way.
Ocarina is tracked with Git, and can be cloned from the following sources:
- The most recent release. This branch does not change frequently.
- Changes that will be included in the next release. This branch is for testing and bugfixing.
cmaketo control the build process. After cloning the code, run
cmake . to generate the Makefile. Compile using
Ocarina supports the following options, which can be passed to
cmake -D<option>=<ON|OFF>. For example,
cmake -DCONFIG_DEBUG=ON would enable debugging.
- Compile with debugging symbols enabled
- Enable extra output when running unit tests
- Enable running GUI unit tests
- Enable unit tests that fetch album artwork
Once compiled, Ocarina can be run by invoking
bin/ocarina on the command line.
The following options can be passed to Ocarina during startup
- -h, --help
- Print help message and exit
- -n, --next
- Tell a running Ocarina instance to play the next track
- P, --pause
- Tell a running Ocarina instance to pause playback
- -p, --play
- Tell a running Ocarina instance to start playback
- -N, --previous
- Tell a running Ocarina instance to play the previous track
- -t, --toggle
- Tell a paused Ocarina instance to begin playback, or tell a playing Ocarina instance to pause.
- -v, --version
- Print Ocarina version and exit
make install will install Ocarina for use by all users. There is currently no "uninstall" option.
make tests will compile and run the Ocarina unit tests. See the CMake Options section above for additional testing options.