socketcan-bcm: Fix wrongly opened socket
[apps/agl-service-can-low-level.git] / README.md
index 3ae3775..2637f7f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,16 @@
-# OpenXC Message Format Specification
+# CAN signaling binder
 
-There are two valid message types - single valued and evented.
+CAN bus binder, based upon OpenXC vi-firmware project.
 
-There may not be a 1:1 relationship between input and output signals - i.e. raw
-engine timing CAN signals may be summarized in an "engine performance" metric on
-the abstract side of the interface.
+Full document can be found under `docs` directory.
 
-## Single Valued
+# Fast build procedure
 
-The expected format of a single valued message is:
+Just use autobuild script:
 
-{% highlight javascript %}
-{"name": "steering_wheel_angle", "value": 45}
-{% endhighlight %}
+```bash
+./conf.d/autobuild/agl/autobuild build
+./conf.d/autobuild/agl/autobuild package
+```
 
-## Evented
-
-The expected format of an event message is:
-
-{% highlight javascript %}
-{"name": "button_event", "value": "up", "event": "pressed"}
-{% endhighlight %}
-
-This format is good for something like a button event, where there are two
-discrete pieces of information in the measurement.
+This will build both projects under build directory for each of them with default configuration.