diff --git a/README b/README deleted file mode 100644 index 4778c60d..00000000 --- a/README +++ /dev/null @@ -1,20 +0,0 @@ -Alternate clone url: - $ git clone git://git.ocarinaproject.net/anna/ocarina.git - -Build: - $ scons - -Clean: - $ scons -c - -Install: - $ sudo scons install - -Uninstall: - $ sudo scons -c install - -Build tests: - $ scons tests - -Clean tests: - $ scons -c tests diff --git a/README.md b/README.md new file mode 100644 index 00000000..ee6a19ea --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Ocarina 6.5 +Ocarina is a simple GTK+ and GStreamer based music player written to let you listen to your music without getting in the way. + +### Git +Ocarina is tracked with Git, and can be cloned from the following sources: +* http://git.nowheycreamery.com/anna/ocarina.git +* git://git.nowheycreamery.com/anna/ocarina.git + +##### Branches +* [master] + * The most recent release. This branch does not change frequently. +* [next] + * Changes that will be included in the next release. This branch is for testing and bugfixing. + +### Building +Ocarina uses `cmake`to control the build process. After cloning the code, run `cmake .` to generate the Makefile. Compile using `make` + +##### CMake Options +Ocarina supports the following options, which can be passed to `cmake` through `cmake -D