Skip to content

Commit

Permalink
README: added usage
Browse files Browse the repository at this point in the history
Signed-off-by: Adrian Matejov <a.matejov@centrum.sk>
  • Loading branch information
Adman committed Feb 14, 2015
1 parent 7011794 commit a8b4c07
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,19 @@ NXCRelativeCompassLib

NXC Library for relative compass

## Usage

Firstly, you need to set up port of the compass
i.e. `NRC_set_compass_port(IN_1);`

Rotate robot to the relative north and run following
`NRC_set_north();`

Then you are able to call method which tells you current angle from relative norht
`int angle = NRC_get_angle();`


## Licence
Licenced under the BSD License.

(c) 2013, XLC Team
(c) 2013-2015, XLC Team

0 comments on commit a8b4c07

Please sign in to comment.