diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9ac99f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/cmake-build-debug/ +.idea \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index 8a7d9c4..ffa3890 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,5 @@ cmake_minimum_required(VERSION 3.26) +set(CMAKE_CXX_STANDARD 26) project(uml) add_library(uml source/Vector3.cpp) diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..5a7cea6 --- /dev/null +++ b/readme.md @@ -0,0 +1,40 @@ +# Universal Math Library (UML) + +## Overview +The Universal Math Library (UML) is a comprehensive, open-source library aimed at providing efficient, reliable, and versatile mathematical functions and algorithms. Developed primarily in C++, this library is designed to cater to a wide range of mathematical operations essential in scientific computing, engineering, and academic research. + +## Features +- **Efficiency**: Optimized for performance, ensuring quick computations. +- **Versatility**: Includes a wide array of mathematical functions and algorithms. +- **Ease of Use**: Simplified interface for convenient integration into various projects. + +## Getting Started +### Prerequisites +- C++ Compiler +- CMake (for building the project) + +### Installation +1. Clone the repository: + ``` + git clone https://github.com/VladislavAlpatov/uml.git + ``` +2. Navigate to the project directory: + ``` + cd uml + ``` +3. Build the project using CMake: + ``` + cmake --build cmake-build-debug --target uml -j 6 + ``` + +## Usage +(Provide examples of how to use the library. Include basic code snippets demonstrating the use of key functions.) + +## Contributing +Contributions to UML are welcome! Please read `CONTRIBUTING.md` for details on our code of conduct and the process for submitting pull requests. + +## License +This project is licensed under the GPL V3 - see the `LICENSE` file for details. + +## Acknowledgments +- (List any contributors, third-party libraries, or resources used in the development of UML)