update docs

Author: blueloveTH

CMakeLists.txt

@@ -43,14 +43,13 @@ if(MSVC)
         /wd4305
         )
     target_link_options(${PROJECT_NAME} PRIVATE /NODEFAULTLIB)
-    message("MSVC set")
 else()
     target_compile_options(${PROJECT_NAME} PRIVATE -O2 -ffp-contract=off)
     target_link_options(${PROJECT_NAME} PRIVATE -nostdlib)
-    message("GCC/Clang set")
 endif()
 
 target_include_directories(${PROJECT_NAME} PRIVATE include/common)
+target_include_directories(${PROJECT_NAME} INTERFACE include/public)
 
 if(WIN32)
     target_include_directories(${PROJECT_NAME} PRIVATE include/win32)
@@ -62,6 +61,5 @@ option(BUILD_TESTS "Build tests" OFF)
 
 if(BUILD_TESTS)
     add_executable(dmath_test tests/main.c)
-    target_include_directories(dmath_test PRIVATE include/public)
     target_link_libraries(dmath_test dmath)
 endif()

README.md

@@ -1,3 +1,41 @@
 # dmath
 
-Deterministic Math Library for C11 Based on Musl
+`dmath` is a deterministic math library for game projects that running on standard mobile and desktop platforms. `dmath` is a drop-in replacement for the math library in C11. It is based on [musl-libc v1.2.5](https://musl.libc.org/) with modifications to ensure that all floating-point operations are deterministic across different platforms and compilers. Although musl-libc is primarily designed for Linux, `dmath` can be used on various platforms, including Windows and MacOS. [pocketpy](https://github.com/pocketpy/pocketpy) uses `dmath` as its math library when compiled with `-DPK_ENABLE_DETERMINISM=ON`.
+
+> `dmath` is not designed for embedded systems.
+
+## Installation
+
+Clone this repo or add it as a submodule to your project directory.
+Then add the following line to your `CMakeLists.txt`:
+
+```cmake
+add_subdirectory(<path_to_dmath_repo>)
+
+target_link_libraries(<your_target> dmath)
+```
+
+## Tested Platforms
+
+We have tested `dmath` on the following platforms and configurations.
+
+| Job                    | OS           | Arch    | Compiler |
+| ---------------------- | ------------ | ------- | -------- |
+| build_ubuntu           | Ubuntu 22.04 | x86_64  | gcc      |
+|                        |              |         | clang    |
+| build_ubuntu_multiarch | Ubuntu 22.04 | x86     | gcc      |
+|                        |              |         | clang    |
+|                        |              | aarch64 | gcc      |
+|                        |              |         | clang    |
+|                        |              | armv7   | gcc      |
+|                        |              |         | clang    |
+| build_macos            | MacOS 14     | x86_64  | clang    |
+| build_win32            | Windows 2022 | x86_64  | cl       |
+
+## References
+
+https://box2d.org/posts/2024/08/determinism/
+
+## License
+
+MIT License