anna
/
ocarina
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

Introduce README 

README has basic commands for building / cleaning
I also update the DESIGN file a bit.

Signed-off-by: Anna Schumaker <schumaker.anna@gmail.com>
This commit is contained in:
Anna Schumaker 2014-03-02 10:42:22 -05:00 committed by Anna Schumaker
parent 5109d629ae
commit 0cf38aaf56
2 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
DESIGN
View File

@ -4,13 +4,14 @@
= = = =
=============================================================================== ===============================================================================
Ocarina 6.0 is the 6th (re)writing of the Ocarina music player - a lightweight, Ocarina 6.0 is the 6th implementation of the Ocarina music player - a
GTK+ based music player. Improvements over the 5.x series will include the lightweight, GTK+ based music player with all the features that I want.
existence of both a design document and unit tests, two items that will help Improvements over the 5.x series will include the existence of both a design
the main developer stay focused and make maintenance easier. document (this file) and unit tests. This should make maintenance easier and
help me stay focused.
Ocarina 6.0 will use Gstreamer 1.0 for audio playback and GTK-MM 3 for user Ocarina 6.0 will use Gstreamer 1.0 for audio playback, GTK-MM 3 for user
interface development. interface development, and Taglib for extracting tags.
@ -64,7 +65,7 @@ Files:
Install: Install:
Ocarina will be compiled into a single executable placed under Ocarina will be compiled into a single executable placed under
/usr/bin/. Any extra files needed to run will be placed under /usr/bin/. Any extra files needed to run will be placed under
/usr/lib/ocarina/. /usr/share/ocarina/.

11
README Normal file
View File

@ -0,0 +1,11 @@
Build:
$ scons
Clean:
$ scons -c
Build tests:
$ scons tests
Clean tests:
$ scons -c tests