Design: Add version and printing info
Signed-off-by: Bryan Schumaker <bjschuma@gmail.com>
This commit is contained in:
parent
0b2fc03f19
commit
04d4aca772
29
design.txt
29
design.txt
|
@ -12,6 +12,7 @@ because I had no overall plan. This document aims to fix that.
|
|||
I will also create unit tests as I add features so bugs can be found faster.
|
||||
|
||||
|
||||
|
||||
Files:
|
||||
ocarina/
|
||||
design.txt
|
||||
|
@ -27,6 +28,8 @@ Files:
|
|||
library.h
|
||||
playlist.h
|
||||
prefs.h
|
||||
print.h
|
||||
version.h
|
||||
ocarina/lib/
|
||||
audio.cpp
|
||||
database.cpp
|
||||
|
@ -36,6 +39,7 @@ Files:
|
|||
library.cpp
|
||||
playlist.cpp
|
||||
prefs.cpp
|
||||
print.cpp
|
||||
ocarina/tests/
|
||||
|
||||
$HOME/.ocarina{-debug}/
|
||||
|
@ -49,6 +53,31 @@ Files:
|
|||
|
||||
|
||||
|
||||
Install:
|
||||
Ocarina will be compiled into a single executable placed under
|
||||
/usr/bin/. Any extra files needed to run will be placed under
|
||||
/usr/lib/ocarina/.
|
||||
|
||||
|
||||
|
||||
Versioning: (include/version.h>
|
||||
During compile a version.h file will be created to use for printing
|
||||
out version information.
|
||||
|
||||
|
||||
|
||||
Printing: (print.cpp>
|
||||
Sometimes text needs to be printed to the screen so users (or debuggers)
|
||||
know what is going on.
|
||||
|
||||
API:
|
||||
void print(string fmt, ...)
|
||||
Print text to the screen
|
||||
void dprint(string fmt, ...)
|
||||
Print text to the screen when debugging is enabled
|
||||
|
||||
|
||||
|
||||
Audio: (lib/audio.cpp)
|
||||
This file will introduce an "audio" namespace containing all of the
|
||||
functions interacting with gstreamer. This will create a wrapper
|
||||
|
|
Loading…
Reference in New Issue