Skip to content

Commit 3651e38

Browse files
committed
Updating typos and some testing information in the README to reflect changes made.
1 parent f5ac560 commit 3651e38

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,20 @@ from the python dbc library here: https://pypi.org/project/cantools/
66

77
## Testing
88

9-
I am trying to alwasy make sure that this is very well tested code. I am using Catch2 to do this
9+
I am trying to always make sure that this is very well tested code. I am using Catch2 to do this
1010
testing and if you aren't familiar here is the documentation: https://github.com/catchorg/Catch2/blob/master/docs/Readme.md#top
1111

12+
To run the tests locally you can use the following:
13+
```bash
14+
mkdir build
15+
cd build
16+
cmake ..
17+
make test -j
18+
```
19+
1220
## Building
1321

14-
I am using Cmake to be able to build the tests. I plan on doing more with it but this is what it
22+
I am using Cmake to be able to build the tests and the lib. I plan on doing more with it but this is what it
1523
is for now. I am doing developement on the WSL Ubuntu 18.04 kernel. This doesn't mean that IDEs aren't
1624
welcome but the build process might not be suited for this. You will need to modify it for your
1725
needs. Feel free to submit changes so the building process will be more robust.
@@ -24,8 +32,6 @@ cmake ..
2432
make
2533
```
2634

27-
These steps produce an executable in the bin folder.
28-
2935
## Contributing
3036

3137
I welcome all help! Please feel free to fork and start some pull requests!

0 commit comments

Comments
 (0)