Skip to content

Commit 1c8dc59

Browse files
Create documentation on how to run the library's tests
1 parent 767b2ae commit 1c8dc59

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

tests/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# How to run the tests
2+
3+
> [!NOTE]
4+
> Requirements: ```Cmake```, ```Make``` and a ```C++``` compiler previously installed.
5+
6+
You have to create a ```build``` subdirectory inside of this one, and once you go there, run the commands: ```cmake ..``` and ```make``` on your shell, in that very order. This will create an executable that you'll be able to run.
7+
8+
> [!TIP]
9+
> You can also chain the commands (including the creation of the build subdirectory) in order to create the executable file as follows:
10+
> ```
11+
> mkdir build && cd build && cmake .. && make
12+
> ```
13+
> This should work at least on both ```Linux```'s terminal and ```Windows```'s ```CMD```.

0 commit comments

Comments
 (0)