Fixed Readme
All checks were successful
Build Docs With Doxygen / Explore-Gitea-Actions (push) Successful in 1m1s

This commit is contained in:
2024-04-10 21:03:59 -04:00
parent 99cedd4987
commit 5b356d9d6e

View File

@@ -1,9 +1,12 @@
# Josh's 3D Math Library - J3ML
===============================
Yet Another C++ Math Standard
J3ML is a "Modern C++" C++ library designed to provide comprehensive support for 3D mathematical operations commonly used in computer graphics, game development, physics simulations, and related fields. It offers a wide range of functionalities to simplify the implementation of complex mathematical operations in your projects.
![Static Badge](https://img.shields.io/badge/Lit-Based-%20)
## Features
* <b>Vector Operations:</b> Comprehensive support for 3D vector operations including addition, subtraction, scalar multiplication, dot product, cross product, normalization, and more.
@@ -22,15 +25,15 @@ To use J3ML in your C++ project, simply include the necessary header files and l
```cpp
#include <iostream>
#include "j3ml/vector3.h"
#include <j3ml/LinearAlgebra.h>
int main() {
// Create two 3D vectors
j3ml::Vector3 v1(1.0, 2.0, 3.0);
j3ml::Vector3 v2(4.0, 5.0, 6.0);
// Create two 3D vectors
Vector3 v1(1.0, 2.0, 3.0);
Vector3 v2(4.0, 5.0, 6.0);
// Perform vector addition
j3ml::Vector3 result = v1 + v2;
Vector3 result = v1 + v2;
// Output the result
std::cout << "Result: " << result << std::endl;