Skip to content

README has been massively updated #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eljonny merged 1 commit into from
Jun 9, 2025
Merged

README has been massively updated #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
867 changes: 686 additions & 181 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions cmake/Includes.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,35 +13,35 @@ endif ()

if (BUILD_TESTING)
target_include_directories (
${PROJECT_NAME}_TestCase_test PRIVATE
${PROJECT_NAME}_test_TestCase PRIVATE
test/include
include
)

target_include_directories (
${PROJECT_NAME}_TestSuite_ctor_test PRIVATE
${PROJECT_NAME}_test_TestSuite_ctor PRIVATE
test/include
include
)
target_include_directories (
${PROJECT_NAME}_TestSuite_running_test PRIVATE
${PROJECT_NAME}_test_TestSuite_running PRIVATE
test/include
include
)
target_include_directories (
${PROJECT_NAME}_TestSuite_tpm_test PRIVATE
${PROJECT_NAME}_test_TestSuite_tpm PRIVATE
test/include
include
)

target_include_directories (
${PROJECT_NAME}_Assertions_basic_test PRIVATE
${PROJECT_NAME}_test_Assertions_basic PRIVATE
test/include
include
)

target_include_directories (
${PROJECT_NAME}_Exceptions_test PRIVATE
${PROJECT_NAME}_test_Exceptions PRIVATE
test/include
include
)
Expand Down
12 changes: 6 additions & 6 deletions cmake/Targets.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,38 +23,38 @@ endif ()

if (BUILD_TESTING)
add_executable (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
test/src/TestCase/TestCaseTests.cpp
test/src/TestCase/TestCaseTestChunks.cpp
test/src/TestCPPTestCaseMain.cpp
)

add_executable (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
test/src/TestSuite/TestSuiteConstructionTests.cpp
test/src/TestCPPTestSuiteConstructionMain.cpp
)

add_executable (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
test/src/TestSuite/TestSuiteRunningTests.cpp
test/src/TestCPPTestSuiteRunningMain.cpp
)

add_executable (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
test/src/TestSuite/TestSuiteTestPassedMessageTests.cpp
test/src/TestCPPTestSuiteTestPassedMessageMain.cpp
)

add_executable (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
test/src/Assertions/AssertionsBasicTests.cpp
test/src/TestCPPAssertionsBasicMain.cpp
)

add_executable (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
test/src/Exceptions/ExceptionsTests.cpp
test/src/TestCPPExceptionsMain.cpp
)
Expand Down
12 changes: 6 additions & 6 deletions cmake/Testing.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
if (BUILD_TESTING)
add_test (
NAME ${PROJECT_NAME}TestCaseTests
COMMAND ${PROJECT_NAME}_TestCase_test
COMMAND ${PROJECT_NAME}_test_TestCase
)

add_test (
NAME ${PROJECT_NAME}TestSuiteConstructionTests
COMMAND ${PROJECT_NAME}_TestSuite_ctor_test
COMMAND ${PROJECT_NAME}_test_TestSuite_ctor
)
add_test (
NAME ${PROJECT_NAME}TestSuiteRunningTests
COMMAND ${PROJECT_NAME}_TestSuite_running_test
COMMAND ${PROJECT_NAME}_test_TestSuite_running
)
add_test (
NAME ${PROJECT_NAME}TestSuiteTestPassedMessageTests
COMMAND ${PROJECT_NAME}_TestSuite_tpm_test
COMMAND ${PROJECT_NAME}_test_TestSuite_tpm
)

add_test (
NAME ${PROJECT_NAME}AssertionsBasicTests
COMMAND ${PROJECT_NAME}_Assertions_basic_test
COMMAND ${PROJECT_NAME}_test_Assertions_basic
)

add_test (
NAME ${PROJECT_NAME}ExceptionsTests
COMMAND ${PROJECT_NAME}_Exceptions_test
COMMAND ${PROJECT_NAME}_test_Exceptions
)
endif ()
12 changes: 6 additions & 6 deletions cmake/build/DebugCompileDefs.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,32 @@ endif ()

if (BUILD_TESTING)
target_compile_definitions (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
PUBLIC
DEBUG_LOG
)
target_compile_definitions (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
PUBLIC
DEBUG_LOG
)
target_compile_definitions (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
PUBLIC
DEBUG_LOG
)
target_compile_definitions (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
PUBLIC
DEBUG_LOG
)
target_compile_definitions (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
PUBLIC
DEBUG_LOG
)
target_compile_definitions (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
PUBLIC
DEBUG_LOG
)
Expand Down
16 changes: 7 additions & 9 deletions cmake/build/GCCClangDebug.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ list (
# capture.
)

if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" OR
"${CMAKE_VS_PLATFORM_TOOLSET}" STREQUAL "ClangCL")

if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
# GCC doesn't support -Wno-global-constructors yet, so only add it
# if we are building with Clang, either with MSVC as a frontend
# or straight-up LLVM.
Expand Down Expand Up @@ -93,35 +91,35 @@ else ()

if (BUILD_TESTING)
target_compile_options (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
PUBLIC
${GCC_CLANG_DEBUG_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
PUBLIC
${GCC_CLANG_DEBUG_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
PUBLIC
${GCC_CLANG_DEBUG_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
PUBLIC
${GCC_CLANG_DEBUG_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
PUBLIC
${GCC_CLANG_DEBUG_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
PUBLIC
${GCC_CLANG_DEBUG_BUILD_OPTS}
)
Expand Down
16 changes: 7 additions & 9 deletions cmake/build/GCCClangRelease.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ list (
# capture.
)

if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" OR
"${CMAKE_VS_PLATFORM_TOOLSET}" STREQUAL "ClangCL")

if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
# GCC doesn't support -Wno-global-constructors yet, so only add it
# if we are building with Clang, either with MSVC as a frontend
# or straight-up LLVM.
Expand Down Expand Up @@ -86,35 +84,35 @@ endif ()

if (BUILD_TESTING)
target_compile_options (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
PUBLIC
${GCC_CLANG_RELEASE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
PUBLIC
${GCC_CLANG_RELEASE_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
PUBLIC
${GCC_CLANG_RELEASE_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
PUBLIC
${GCC_CLANG_RELEASE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
PUBLIC
${GCC_CLANG_RELEASE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
PUBLIC
${GCC_CLANG_RELEASE_BUILD_OPTS}
)
Expand Down
12 changes: 6 additions & 6 deletions cmake/build/GCCCoverage.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,35 +38,35 @@ target_compile_options (
)

target_compile_options (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
PUBLIC
${COVERAGE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
PUBLIC
${COVERAGE_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
PUBLIC
${COVERAGE_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
PUBLIC
${COVERAGE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
PUBLIC
${COVERAGE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
PUBLIC
${COVERAGE_BUILD_OPTS}
)
12 changes: 6 additions & 6 deletions cmake/build/MSVCDebug.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,35 +79,35 @@ endif ()

if (BUILD_TESTING)
target_compile_options (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
PUBLIC
${MSVC_DEBUG_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
PUBLIC
${MSVC_DEBUG_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
PUBLIC
${MSVC_DEBUG_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
PUBLIC
${MSVC_DEBUG_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
PUBLIC
${MSVC_DEBUG_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
PUBLIC
${MSVC_DEBUG_BUILD_OPTS}
)
Expand Down
12 changes: 6 additions & 6 deletions cmake/build/MSVCRelease.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,35 +68,35 @@ endif ()

if (BUILD_TESTING)
target_compile_options (
${PROJECT_NAME}_TestCase_test
${PROJECT_NAME}_test_TestCase
PUBLIC
${MSVC_RELEASE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_TestSuite_ctor_test
${PROJECT_NAME}_test_TestSuite_ctor
PUBLIC
${MSVC_RELEASE_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_running_test
${PROJECT_NAME}_test_TestSuite_running
PUBLIC
${MSVC_RELEASE_BUILD_OPTS}
)
target_compile_options (
${PROJECT_NAME}_TestSuite_tpm_test
${PROJECT_NAME}_test_TestSuite_tpm
PUBLIC
${MSVC_RELEASE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Assertions_basic_test
${PROJECT_NAME}_test_Assertions_basic
PUBLIC
${MSVC_RELEASE_BUILD_OPTS}
)

target_compile_options (
${PROJECT_NAME}_Exceptions_test
${PROJECT_NAME}_test_Exceptions
PUBLIC
${MSVC_RELEASE_BUILD_OPTS}
)
Expand Down
Loading