Skip to content

Commit af38b36

Browse files
committed
Making changes to the readme on how i am going to be building and testing this library.
1 parent 272bd97 commit af38b36

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# dbc_parser_cpp
1+
# C++ DBC Header Only File Parser
2+
3+
This is to provide a library header only file to read in DBC files. I was looking around and couldn't
4+
find a simple library that didn't have dependencies. So here we are making one. I got some inspiration
5+
from the python dbc library here: https://pypi.org/project/cantools/
6+
7+
## Testing
8+
9+
I am trying to alwasy make sure that this is very well tested code. I am using Catch2 to do this
10+
testing and if you aren't familiar here is the documentation: https://github.com/catchorg/Catch2/blob/master/docs/Readme.md#top
11+
12+
## Building
13+
14+
I am using Cmake to be able to build the tests. I plan on doing more with it but this is what it
15+
is for now. I am doing developement on the WSL Ubuntu 18.04 kernel. This doesn't mean that IDEs aren't
16+
welcome but the build process might not be suited for this. You will need to modify it for your
17+
needs. Feel free to submit changes so the building process will be more robust.
18+
19+
Here are the steps to get started:
20+
```bash
21+
mkdir build
22+
cd build
23+
cmake ..
24+
make
25+
```
26+
27+
These steps produce an executable in the bin folder.
28+
29+
## Contributing
30+
31+
I welcome all help! Please feel free to fork and start some pull requests!
32+
You can see the issues sections for some ideas what might need to be done.

0 commit comments

Comments
 (0)