diff options
| author | dec05eba <dec05eba@protonmail.com> | 2018-09-29 14:24:03 +0200 |
|---|---|---|
| committer | dec05eba <dec05eba@protonmail.com> | 2020-07-06 07:39:33 +0200 |
| commit | 9f3f366deec411675cc21c2fceaa7ac090d03a4c (patch) | |
| tree | 73fca6219c7f9f460e4129f91b2255e502a70fe8 /README.md | |
| parent | ba960a24615b39a4e145b7286afe0f1b5047020a (diff) | |
Remove project.tests, always use tests subdir
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 2 insertions, 4 deletions
@@ -35,6 +35,8 @@ Dependencies that are required to build sibs from source are: # IDE support Sibs generates a compile_commands.json in the project root directory when executing `sibs build` and tools that support clang completion can be used, such as YouCompleteMe. There are several editors that support YouCompleteMe, including Vim, Emacs and Visual Studio Code. +# Tests +If your project contains a sub directory called "tests" then that directory will be used a test project. The test directory may contain a project.conf file which can contain \[dependencies] block for specifying test only dependencies. The test automatically includes the parent project as a dependency. # Project configuration template ```toml [package] @@ -43,7 +45,6 @@ type = "library" version = "0.1.0" platforms = ["linux32", "linux64", "win32", "win64"] authors = ["DEC05EBA <0xdec05eba@gmail.com>"] -tests = "tests" include_dirs = ["include"] ignore_dirs = ["examples"] @@ -106,9 +107,6 @@ If platforms contains "any", then other there is no need to specify other platfo ### authors Optional. A list of authors -### tests -Optional. Path which contains tests. The test directory may contain a project.conf file which can contain \[dependencies] block for specifying test only dependencies. The test automatically includes the parent project as a dependency. - ### include_dirs Optional. A list of directories which should be specified as global include directories when compiling. This means that instead of using relative paths to header files, you can include the directory with headers and then you only have to specify the header name when using #include |