Skip to content

Commit 8c4eff8

Browse files
committed
Revise README to provide up-to-date build instructions.
1 parent 565b2dd commit 8c4eff8

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
# Math
22

3-
A mathematic library implementation, first concentrating on linear algrebra
3+
Generic mathematical library, featuring strongly-typed support for linear algebra and other essential topics for graphics programming.
44

5-
## Development
5+
The library aims to provide type-safe implementations for common mathematical operations in computer graphics,
6+
including vector and matrix algebra, transformations, pose representations,
7+
and interpolation.
68

7-
Build environment setup:
9+
## Build (with Conan 2)
810

9-
git clone --recurse-submodules [email protected]:Adnn/Math.git
10-
cd Math
11-
mkdir build && cd build
12-
cmake ..
13-
# Actual build command
14-
cmake --build .
11+
* Ensure [the pre-requisites](https://github.com/ShredEagle/public_build_info?tab=readme-ov-file#requirements) are met.
12+
* Clone:
13+
```bash
14+
git clone --recurse-submodule https://github.com/ShredEagle/math.git
15+
cd math
16+
```
17+
* Build:
18+
```bash
19+
conan build ./conan/
20+
```
21+
22+
## Build System and Dependencies
23+
24+
The project uses CMake for its build scripts,
25+
which is sufficient for building the project.
26+
However, CMake does not manage upstream dependencies.
27+
28+
To address this, a Conan recipe is provided on top of the CMake scripts.
29+
It handles dependency management and facilitates the integration
30+
inside a dependency graph.

0 commit comments

Comments
 (0)