design: Cleanups to each section
Signed-off-by: Anna Schumaker <schumaker.anna@gmail.com>
This commit is contained in:
parent
0386b24309
commit
f7d08724a3
57
DESIGN
57
DESIGN
|
@ -15,53 +15,6 @@ interface development, and Taglib for extracting tags.
|
|||
|
||||
|
||||
|
||||
Files:
|
||||
$HOME/.ocarina{-debug}/
|
||||
album.db
|
||||
artist.db
|
||||
genre.db
|
||||
library.db
|
||||
playlist.db
|
||||
playqueue.lst
|
||||
track.db
|
||||
/usr/bin/
|
||||
ocarina
|
||||
/usr/lib/ocarina/
|
||||
ocarina/
|
||||
design.txt
|
||||
ocarina/gui/
|
||||
*
|
||||
ocarina6.glade
|
||||
ocarina/include/
|
||||
audio.h
|
||||
callback.h
|
||||
database.h
|
||||
database.hpp
|
||||
deck.h
|
||||
error.h
|
||||
file.h
|
||||
filter.h
|
||||
idle.h
|
||||
idle.hpp
|
||||
library.h
|
||||
playlist.h
|
||||
playqueue.h
|
||||
print.h
|
||||
version.h
|
||||
ocarina/lib/
|
||||
audio.cpp
|
||||
callback.cpp
|
||||
database.cpp
|
||||
deck.cpp
|
||||
file.cpp
|
||||
filter.cpp
|
||||
idle.cpp
|
||||
library.cpp
|
||||
playlist.cpp
|
||||
playqueue.cpp
|
||||
|
||||
|
||||
|
||||
Install:
|
||||
Ocarina will be compiled into a single executable placed under
|
||||
/usr/bin/. Any extra files needed to run will be placed under
|
||||
|
@ -69,7 +22,7 @@ Install:
|
|||
|
||||
|
||||
|
||||
Version: (include/version.h)
|
||||
Version:
|
||||
This file contains a simple function for returning a string stating
|
||||
the current version. The current version will be set by the build
|
||||
system and passed using the CONFIG_VERSION macro.
|
||||
|
@ -80,7 +33,7 @@ API:
|
|||
|
||||
|
||||
|
||||
Errors: (include/error.h
|
||||
Errors:
|
||||
This file contains an enum defining error codes used throughout the
|
||||
codebase. Errors will be reported using "throw" and "catch".
|
||||
|
||||
|
@ -95,7 +48,7 @@ Error Codes:
|
|||
|
||||
|
||||
|
||||
Printing: (include/print.h>
|
||||
Printing:
|
||||
Sometimes text needs to be printed to the screen so users (or debuggers)
|
||||
can trace what is going on.
|
||||
|
||||
|
@ -108,7 +61,7 @@ API:
|
|||
|
||||
|
||||
|
||||
Callbacks: (lib/callback.cpp)
|
||||
Callbacks:
|
||||
Callbacks are used to notify a unit test or the gui that something in
|
||||
the backend has changed. The callbacks structure should be initialized
|
||||
with no-op default values and filled in by the user through the
|
||||
|
@ -130,7 +83,7 @@ Callbacks: (lib/callback.cpp)
|
|||
|
||||
|
||||
|
||||
On-disk files: (lib/file.cpp)
|
||||
On-disk files:
|
||||
Data will be stored in the user's home directory according to the
|
||||
XDG / freedesktop.org specification. This means data will be stored
|
||||
in a subdirectory of $XDG_DATA_HOME.
|
||||
|
|
Loading…
Reference in New Issue