Skip to content

Commit 8280a31

Browse files
Add test documentation, including a GIF showing the test execution
1 parent 73cbe41 commit 8280a31

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
66
```C++```'s native input/output library (```iostream```) doesn't provide the kind of high-level functions that you might like to use in your own projects, such as clearing the console, or stopping the natural control flow until a given key is pressed. This library aims to solve that in an beginner-friendly approach!
77

8+
### Tests running
9+
![](assets/test.gif)
10+
811
## How to implement in your own projects, using ```CMake```
912

1013
> [!TIP]
@@ -45,7 +48,7 @@ Your project's main ```CMakeLists.txt```:
4548
include(FetchContent)
4649
4750
FetchContent_Declare( cpp-safe-io
48-
GIT_REPOSITORY https://github.com/DanielRamirez404/Cpp-Safe-IO.git
51+
GIT_REPOSITORY https://github.com/DanielRamirez404/CppSafeIO.git
4952
GIT_TAG v1.1.0
5053
GIT_SHALLOW TRUE
5154
)
@@ -88,3 +91,8 @@ int main()
8891
* ```void ignoreExceedingInput()```: clears ```std::cin```'s buffer.
8992
* ```void parseYesNoInput()```: gets one character input and returns true or false if it matches the ```Y``` or ```N``` characters, respectively (case insensitive). On failure, it throws a ```std::runtime_error```.
9093
* ```std::string getInputLine():``` gets all entered input until a line break, as a ```std::string```.
94+
95+
## Testing
96+
97+
> [!TIP]
98+
> You can test this library's functions in the ```tests``` subdirectory.

0 commit comments

Comments
 (0)