Skip to content

Commit 95c4d9c

Browse files
committed
Add some requirements and readme to examples
1 parent 8478a47 commit 95c4d9c

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,25 @@ openmotordrive/framework is a framework for embedded applications, primarily tar
4343
|uavcan_restart|Provides a uavcan.protocol.RestartNode server|
4444
|worker_thread|Provides worker threads that can process timer tasks, which run after a delay, or listener tasks, which listen to pubsub messages|
4545

46+
## REQUIREMENTS
47+
Some installations requirements and help.
48+
49+
### Submodules :
50+
After cloning, get the submodules with :
51+
52+
```bash
53+
git submodule update --init --recursive
54+
```
55+
56+
### Toolchain :
57+
Tested with gcc6 and gcc7
58+
59+
On Ubuntu 16.04, you can use [team-gcc-arm-embedded](https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa) version
60+
61+
### Others
62+
It needs crcmod and uavcan python package
63+
64+
```bash
65+
sudo pip install -U crcmod uavcan
66+
```
4667

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Usage
2+
Set BOARD_DIR according to you board directory.
3+
4+
### Example
5+
6+
```bash
7+
BOARD_DIR=boards/com.hex.cube_1.0 make
8+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Usage
2+
Set BOARD_DIR according to you board directory.
3+
4+
### Example
5+
6+
```bash
7+
BOARD_DIR=boards/com.hex.cube_1.0 make
8+
```

0 commit comments

Comments
 (0)