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

better readme

Browse source
This commit is contained in:
array-in-a-matrix 2023-01-16 16:43:28 -05:00
parent d2ef02cb2e
commit 612a15fd5e
2 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,3 +1,15 @@
# Multrix
Matrix multiplication calculator; calculates the cross & dot products of 2 matrices.
Matrix multiplication calculator; calculates the cross & dot products of matrices and vectors.
## 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`.

2
src/main.nim
View file

@ -27,5 +27,5 @@ else:
of "c":
cross()
else:
quit "Invalid matrix operation!", QuitFailure
quit "Invalid operation!", QuitFailure