From a0ff952ef4fa6e594e3bc1af6cf1882873e40a68 Mon Sep 17 00:00:00 2001 From: Orange Date: Fri, 15 Nov 2024 11:51:19 +0300 Subject: [PATCH] improved README added CoC --- CODE_OF_CONDUCT.md | 92 ++++++++++++++++++++++++++++++++++++++++++ readme.md => README.md | 10 +++-- SECURITY.md | 5 +++ 3 files changed, 103 insertions(+), 4 deletions(-) create mode 100644 CODE_OF_CONDUCT.md rename readme.md => README.md (82%) create mode 100644 SECURITY.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bbdccf9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,92 @@ +## Goal + +My goal is to provide a space where it is safe for everyone to contribute to, +and get support for, open-source software in a respectful and cooperative +manner. + +I value all contributions and want to make this project and its +surrounding community a place for everyone. + +As members, contributors, and everyone else who may participate in the +development, I strive to keep the entire experience civil. + +## Standards + +Our community standards exist in order to make sure everyone feels comfortable +contributing to the project(s) together. + +Our standards are: +- Do not harass, attack, or in any other way discriminate against anyone, including + for their protected traits, including, but not limited to, sex, religion, race, + appearance, gender, identity, nationality, sexuality, etc. +- Do not go off-topic, do not post spam. +- Treat everyone with respect. + +Examples of breaking each rule respectively include: +- Harassment, bullying or inappropriate jokes about another person. +- Posting distasteful imagery, trolling, or posting things unrelated to the topic at hand. +- Treating someone as worse because of their lack of understanding of an issue. + +## Enforcement + +Enforcement of this CoC is done by Orange++ and/or other core contributors. + +I, as the core developer, will strive my best to keep this community civil and +following the standards outlined above. + +### Reporting incidents + +If you believe an incident of breaking these standards has occurred, but nobody has +taken appropriate action, you can privately contact the people responsible for dealing +with such incidents in multiple ways: + +***E-Mail*** +- `orange-cpp@yandex.ru` +- +***Discord*** +- `@orange_cpp` + +***Telegram*** +- `@orange-cpp` +I guarantee your privacy and will not share those reports with anyone. + +## Enforcement Strategy + +Depending on the severity of the infraction, any action from the list below may be applied. +Please keep in mind cases are reviewed on a per-case basis and members are the ultimate +deciding factor in the type of punishment. + +If the matter would benefit from an outside opinion, a member might reach for more opinions +from people unrelated to the organization, however, the final decision regarding the action +to be taken is still up to the member. + +For example, if the matter at hand regards a representative of a marginalized group or minority, +the member might ask for a first-hand opinion from another representative of such group. + +### Correction/Edit + +If your message is found to be misleading or poorly worded, a member might +edit your message. + +### Warning/Deletion + +If your message is found inappropriate, a member might give you a public or private warning, +and/or delete your message. + +### Mute + +If your message is disruptive, or you have been repeatedly violating the standards, +a member might mute (or temporarily ban) you. + +### Ban + +If your message is hateful, very disruptive, or other, less serious infractions are repeated +ignoring previous punishments, a member might ban you permanently. + +## Scope + +This CoC shall apply to all projects ran under the Orange++ lead and all _official_ communities +outside of GitHub. + +However, it is worth noting that official communities outside of GitHub might have their own, +additional sets of rules. \ No newline at end of file diff --git a/readme.md b/README.md similarity index 82% rename from readme.md rename to README.md index 07bb7c4..4fca58d 100644 --- a/readme.md +++ b/README.md @@ -17,6 +17,8 @@ Oranges's Math Library (omath) is a comprehensive, open-source library aimed at - **Ease of Use**: Simplified interface for convenient integration into various projects. - **Projectile Prediction**: Projectile prediction engine with O(N) algo complexity, that can power you projectile aim-bot. - **3D Projection**: No need to find view-projection matrix anymore you can make your own projection pipeline. +- **Collision Detection**: Production ready code to handle collision detection by using simple interfaces. +- **No Additional Dependencies**: No additional dependencies need to use OMath except unit test execution ## Getting Started ### Prerequisites @@ -34,10 +36,10 @@ Oranges's Math Library (omath) is a comprehensive, open-source library aimed at ``` 3. Build the project using CMake: ``` - cmake --preset x64-release -S . - cmake --build cmake-build/build/x64-release --target server -j 6 + cmake --preset windows-release -S . + cmake --build cmake-build/build/windows-release --target server -j 6 ``` - + Use **\-\** preset to build siutable version for yourself. Like **windows-release** or **linux-release**. ## Usage Simple world to screen function ```c++ @@ -64,7 +66,7 @@ With `omath/projection` module you can achieve simple ESP hack for powered by So Contributions to `omath` 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. +This project is licensed under the MIT - see the `LICENSE` file for details. ## Acknowledgments - Orange | [Telegram](https://t.me/orange_cpp) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..190b1a5 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,5 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report security issues to `orange-cpp@yandex.com` \ No newline at end of file