Code Review
/
apps
/
agl-service-can-low-level.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Update README instructions.
[apps/agl-service-can-low-level.git]
/
README.md
diff --git
a/README.md
b/README.md
index
55fc453
..
1629ffb
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,9
+1,23
@@
-#
Low level
CAN signaling binder
+# CAN signaling binder
-Low level CAN bus binder, based upon OpenXC vi-firmware project.
+CAN bus binder, based upon OpenXC vi-firmware project.
+
+There are 2 separated projects here, one with the CAN-binder that is installed
+on an AGL target and the CAN config generator used to generate a source file for
+the low level binding.
Full document can be found under `docs` directory.
Full document can be found under `docs` directory.
+# Fast build procedure
+
+Just use build.sh script:
+
+```bash
+./build.sh
+```
+
+This will build both projects under build directory for each of them with default configuration.
+
# Generate documentation
## Prerequisites
# Generate documentation
## Prerequisites
@@
-18,7
+32,7
@@
sudo apt-get install calibre
To generate Doxygen documentation, you'll need doxygen and graphviz:
```bash
To generate Doxygen documentation, you'll need doxygen and graphviz:
```bash
-sudo apt-get doxygen graphviz
+sudo apt-get
install
doxygen graphviz
```
Prepare your build environment:
```
Prepare your build environment:
@@
-50,4
+64,4
@@
gendocs.sh doxygen
or
```bash
cd build && make doxygen
or
```bash
cd build && make doxygen
-```
\ No newline at end of file
+```