Skip to content

Commit 1a4ba6a

Browse files
committed
docs: Update various references and texts
Signed-off-by: Brendan Le Foll <[email protected]>
1 parent eb7238d commit 1a4ba6a

File tree

5 files changed

+20
-6
lines changed

5 files changed

+20
-6
lines changed

COPYING

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The MIT License (MIT)
2-
Copyright © 2014-2016 Intel Corporation
2+
Copyright © 2014-2018 Intel Corporation
33

44
Permission is hereby granted, free of charge, to any person obtaining
55
a copy of this software and associated documentation files (the

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ sudo zypper in mraa
9999
Installing for Node.js only
100100
---------------------------
101101

102-
> Note: Node.js 7.0.0+ is not supported. You'll have to downgrade to 6.x.x.
102+
> Note: Node.js 7.0.0+ is not currntly supported. You'll have to downgrade to 6.x.x.
103103
104104
You can also install just the node.js mraa module by using npm. You will need a
105105
C++ compiler and the node development headers, however it's not required to

docs/debugging.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ this list as it's the first thing we'll ask you to do.
88

99
Getting the exact version of libmraa you're running is really important to us.
1010
The best way to get this is to call mraa_get_version() or mraa.getVersion(). If
11-
mraa returns x.x.x-dirty then your version was not built from a git tree or you
12-
built out of tree (see our building doc) - or you don't have git installed.
11+
you built from git then please tell us which commit hash you used. Mraa no
12+
longer tags itself as 'dirty' if built as a non tagged version but simply uses
13+
the latest version number listed in the top level CMakeLists.txt file. Note
14+
that you may have to wipe the build/ dir for git sha version to be absolutely
15+
correct.
1316

1417
### Finding error logs
1518

@@ -22,10 +25,12 @@ systemd likely your log is in /var/log/messages or a similar location.
2225

2326
### Common errors to check for
2427

25-
* Not running as root
28+
* Not running as a user with permissions to the physical char devices/files
29+
that require access. Check quickly if it works as root and you likely have
30+
such an issue. The log file will reflect this
2631
* Incorrect IO pin numbers, mraa uses physical connector pin numbering see your
2732
platform documentation for details
28-
* Your platform is unsupported
33+
* Your platform is unsupported or has been detected wrongly (logfile will show this)
2934
* Using the wrong pin, check pin capabilities either using the API or your
3035
platform documentation
3136

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ Specific platform information for supported platforms is documented here:
5151
- @ref up2
5252
- @ref joule
5353
- @ref ft4222
54+
- @ref _96boards
55+
- @ref de10-nano
56+
- @ref firmata
57+
- @ref grovepi
58+
- @ref mock
5459

5560
## DEBUGGING
5661

docs/internals.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ conversions and memory allocations are performed so the performance of using
166166
these functions compared to the C/C++ equivalent will likely be a little lower,
167167
however it is much more natural than using carrays.i typemap library.
168168

169+
Note that node v7.x.x is not yet supported in SWIG, however this is a patchset
170+
in SWIG that enables this and does enable mraa to compile and work against a
171+
newer nodejs version.
172+
169173
### NPM ###
170174

171175
mraa is published on NPM, there is a target to prebuild a mraa src tarball that

0 commit comments

Comments
 (0)