README

AVR module: CAN - using MCP2515 and MCP2551
================================================================================

A submodule used in other projects. Currently cmake is used to build a library
of the module. The path structure within the project should be as follows.
The includes are looked for in the subdirectory "config", "spi" and "util" at
the same level as the module.

Environment:
------------

<some project path>
:
|
+- config
|  |
|  +- can_config_mcp2515.c
|  +- can_config_mcp2515.h
|  +- spi_config.h
|
+- can
|  |
|  +- <submodule sources>
|
+- spi
|  |
|  +- <submodule sources>
|
+- util
   |
   +- <submodule util files>

Use the following git commands to get the submodule:

# to get the submodule
git submodule add git@github.com:mkleemann/can.git <path/to/can/module>
# commit the submodule to your repository
git commit

# update your submodule, when needs be
git submodule update

To use the submodule, you may make use of the cmake-avr toolchain. The
project has to define the include search path at the parent directory
of the module.

Have fun!

M.