diff --git a/README.md b/README.md index be605b0..4bf16f5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ + +![Logo](https://git.lowearthorbit.de/attachments/89a7215a-33ac-4284-a3c5-5647167802c3) + + # curtle -Curtle is a smart turtle that helps you with math tasks. \ No newline at end of file +curtle is a simple open source cross platform math library for C. +## Roadmap +The goal of curtle is to provide an easy to use and easy to integrate math library. If you are interested in specific features please reach out to me! + +- add much math tooling +- provide easy install via package managers etc. + + +## Features + +- Basic operations on 2D Vectors +- Basic operations on 3D Vectors + + +## Installation + +Clone the repository: +``` +git clone https://git.lowearthorbit.de/lowearthorbit/curtle.git +cd curtle +``` +You can build and install the library using cmake: +``` +mkdir build && cd build +cmake .. +sudo cmake --install . +``` +## Usage/Examples + +Once installed, you can use curtle with CMake: + +```CMake +find_package(curtle REQUIRED) + +add_executable(myapp main.c) +target_link_libraries(myapp PRIVATE curtle::curtle) +``` + +Example in C +```C +#include "curtle/curtle.h" + +int main(void) { + struct vec2 a = { 1.0, 1.0 }; + printf("%f", vec2_len(a)); // Prints sqrt(2) +} +``` +## Authors + +- [@lowearthorbit](https://git.lowearthorbit.de/lowearthorbit) +