feat: readme and doxyfile

This commit is contained in:
2025-08-23 13:17:52 +02:00
parent 24ebb67fb5
commit ed775a2da0
2 changed files with 92 additions and 5 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# TSTD
A C library providing various string manipulation utilities.
## Usage
To use TSTD in your CMake project, you can either build it from source or include it using FetchContent.
### Integration with FetchContent
Add the following to your CMakeLists.txt:
```cmake
cmake_minimum_required(VERSION 3.20)
project(myproj C)
set(CMAKE_C_STANDARD 23)
set(CMAKE_C_STANDARD_REQUIRED ON)
include(FetchContent)
FetchContent_Declare(
tstd
GIT_REPOSITORY https://github.com/Tilo-K/tstd.git
GIT_TAG main
)
FetchContent_MakeAvailable(tstd)
add_executable(myapp src/main.c)
target_link_libraries(myapp PRIVATE tstd)
```