array-in-a-matrix
/
multrix
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 4 Wiki Activity

Update README.md

This commit is contained in:
array-in-a-matrix 2024-01-31 12:56:18 -05:00
parent ec084ce210
commit e9d4f763e0
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,15 +4,23 @@ Matrix multiplication calculator; calculates the cross & dot products of matrice
## Usage
To calculate the dot product of 2 matrices execute the `dot` command or `multrix` command in the output `bin` directory.
To calculate the cross product of 2 vectors execute the `cross` command or `multrix` command in the output `bin` directory.
The `multrix` command can calculate both dot or cross products if given the respective command line argument. If no valid commandline argument is given the program will ask which type of calculation should be made.
## installation
The program requires no dependencies other than the nim standard library. Just run `make` in the root of the project and run the executables in `bin`.
To install using nimble:
```sh
nimble install https://git.inamatrix.xyz/array-in-a-matrix/multrix
```
To install using pacman:
```sh
git clone https://git.inamatrix.xyz/array-in-a-matrix/multrix
cd multrix
makepkg si
```
## Math