From 612a15fd5ea81be05daccf137b1341f36a70e765 Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 16 Jan 2023 16:43:28 -0500 Subject: [PATCH] better readme --- README.md | 14 +++++++++++++- src/main.nim | 2 +- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d111a40..f9d6fe7 100644 --- a/README.md +++ b/README.md @@ -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`. diff --git a/src/main.nim b/src/main.nim index 8b1e7e4..c462fd8 100644 --- a/src/main.nim +++ b/src/main.nim @@ -27,5 +27,5 @@ else: of "c": cross() else: - quit "Invalid matrix operation!", QuitFailure + quit "Invalid operation!", QuitFailure