diff --git a/design.txt b/design.txt index eb940ee1..b0657d2c 100644 --- a/design.txt +++ b/design.txt @@ -41,6 +41,7 @@ Files: playlist.h prefs.h print.h + test.h version.h ocarina/lib/ audio.cpp @@ -53,6 +54,7 @@ Files: library.cpp playlist.cpp prefs.cpp + test.cpp @@ -75,6 +77,19 @@ API: +Test framework: (lib/test.cpp) + Unit tests will require a basic framework for manipulating files and + directories in the filesystem. Compiling the tests/ directory will + enable the CONFIG_TEST option, which in turn compiles the test library. + +API: + void rm_test_config() + Remove the $XDG_CONFG_HOME/ocarina-test/ directory. + void rm_test_data() + Remove the $XDG_DATA_HOME/ocarina-test/ directory. + + + Versioning: (include/version.h) This file contains a simple function for returning a string stating the current version. diff --git a/design/test.txt b/design/test.txt new file mode 100644 index 00000000..d9d8fb24 --- /dev/null +++ b/design/test.txt @@ -0,0 +1,19 @@ +== Files == + ocarina/include/ + test.h + ocarina/lib/ + test.cpp + +== Depends == +install + +Test framework: (lib/test.cpp) + Unit tests will require a basic framework for manipulating files and + directories in the filesystem. Compiling the tests/ directory will + enable the CONFIG_TEST option, which in turn compiles the test library. + +API: + void rm_test_config() + Remove the $XDG_CONFG_HOME/ocarina-test/ directory. + void rm_test_data() + Remove the $XDG_DATA_HOME/ocarina-test/ directory.