summaryrefslogtreecommitdiffstats
path: root/meta-agl-distro/conf/layer.conf
blob: 74527516af15dc3ffcbc4f70fb07587d015487ec (plain) 
1
2
3
4
5
6
7
8
9
10

# We have a conf and classes directory, add to BBPATH
BBPATH =. "${LAYERDIR}:"

# We have recipes-* directories, add to BBFILES
BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \
            ${LAYERDIR}/recipes-*/*/*.bbappend"

BBFILE_COLLECTIONS += "agl-distro"
BBFILE_PATTERN_agl-distro = "^${LAYERDIR}/"
BBFILE_PRIORITY_agl-distro = "8"
olor: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ } 
# CAN signaling binder

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.

# 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

You can use gitbook to serve documentation. To do so, please install it using *npm* as well as *calibre* package from your package distribution manager:

```bash
sudo npm install -g gitbook-cli
sudo apt-get install calibre
```

To generate Doxygen documentation, you'll need doxygen and graphviz:

```bash
sudo apt-get install doxygen graphviz
```

Prepare your build environment:

```bash
mkdir build && cd build
cmake ..
```

## Generation

Generate a PDF version :

```bash
gendocs.sh pdf
```

Serve an HTML version, this will run a web server that will serve you locally documentation :

```bash
gendocs.sh serve
```

Generate doxygen documentation:

```bash
gendocs.sh doxygen
```
or
```bash
cd build && make doxygen
```