diff --git a/README.md b/README.md index 5900a6d..ca0f9b2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ # T3DSR Lightweight terminal-based 3d renderer of geometric shapes using ASCII characters. -# Acknowledgments +## Features +- ### 3D Math Optimized with SIMD + - High-performance vector and matrix operations using SSE on x86_64 and NEON on ARM. +- ### Demo + - A fully rotationg 3d cube rendered in ASCII. + - Z-buffering implementation for depth. -I would like to give a thanks to [Unity Test project](https://github.com/ThrowTheSwitch/Unity) for providing an excellent tool. Without it, unit testing would have been much more difficult. \ No newline at end of file +## Usage + +```bash +cmake -B build && \ +make -C build && \ +# run demo +./build/main +``` + +# Requirements +- C compiler (GCC, Clang, etc...) +- make and cmake + +# Roadmap + +This project is intended to be very lightweight, it's mainly an experiment with 3d math and terminal graphics. + +**Feel free to fork it and add some features.** \ No newline at end of file