Skip to content

Commit 626a02d

Browse files
committed
Updated README.md
1 parent c7b8647 commit 626a02d

File tree

2 files changed

+24
-7
lines changed

2 files changed

+24
-7
lines changed

CMakeSettings.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"configurations": [
3+
{
4+
"name": "x64-Release",
5+
"generator": "Ninja",
6+
"configurationType": "RelWithDebInfo",
7+
"inheritEnvironments": [
8+
"msvc_x64_x64"
9+
],
10+
"buildRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\build\\${name}",
11+
"installRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\install\\${name}",
12+
"cmakeCommandArgs": "",
13+
"buildCommandArgs": "-v",
14+
"ctestCommandArgs": ""
15+
}
16+
]
17+
}

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
This project provides a C++ library that reads and parses [CAN](https://en.wikipedia.org/wiki/CAN_bus) databases which can then be analyzed for other purposes.
44

5+
Currently the library only understand a subset of the DBC file format.
6+
57
## Compiling the project
68

7-
Clone the repo on your computer, get into the main directory and run the `make` command:
9+
The project uses CMake to be compiled. It can also be used to easily include the library in your own project.
10+
11+
C++ CAN Parser currently is compiled as a static library.
812

9-
```bash
10-
> git clone https://github.com/xatavian/cpp-can-parser
11-
> cd cpp-can-parser
12-
> make
13-
```
13+
## can-parse
1414

15-
Currently the `main.cpp` does nothing but printing the content of a file into the console.
15+
`can-parse` is a utility program that allows you to parse the content of a CAN database which is then output to the standard output. You can use it to see if the file content is valid or explore the content of the database.
1616

1717
## Supported standards:
1818
* DBC (in progress)

0 commit comments

Comments
 (0)