Skip to content
This repository was archived by the owner on Dec 24, 2017. It is now read-only.

Commit 5b78d4c

Browse files
committed
Update README.md
1 parent ef54d20 commit 5b78d4c

File tree

1 file changed

+1
-24
lines changed

1 file changed

+1
-24
lines changed

README.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ __Please note that Octalbonescript does not recommend Linux Angstrom. We strongl
1818

1919
Examples
2020
--------
21-
Latest code docs and examples are available here: https://github.com/theoctal/octalbonescript/wiki
21+
Latest code docs, examples and migration guide from original bonescript are available here: https://github.com/theoctal/octalbonescript/wiki
2222

2323
Fork
2424
----
@@ -27,27 +27,4 @@ This is a fork of https://github.com/jadonk/bonescript. Some APIs are changed in
2727
This fork is created to make bonescript more feature rich, faster, fix bugs and make it work in
2828
simulator mode under Mac OSX and Linux.
2929

30-
Additional features not present in original bonescript
31-
------------------------------------------------------
32-
33-
### Debug Mode
34-
Debug mode can be activated as per below.
35-
36-
```JavaScript
37-
DEBUG=bone node yourscript.js
38-
```
39-
40-
Differences from bonescript
41-
-------------------------
42-
OctalBoneScript is mostly API compatible with actual bonescript. There are a few changes which you should keep in mind though.
43-
44-
* Pins P8_7, P8_8, P8_9 have to be denoted as P8_07, P8_08, P8_09 in your code.
45-
* ```pinMode``` function now takes only 3 arguments. Please also note that this function is fully __asynchronous__ and non-blocking therefore always use callback to know whether the pinMode execution has occured successfully. Its format is: ```pinmode(pin, direction, callback)```. Additional direction variable ```INPUT_PULLDOWN``` is also added. It asserts mode automatically and sets slew rate as fast by default.
46-
* v1.0.0 introduces ```pinModeSync``` function which is fully synchronous and blocking function. If your code requires this kind of functionality, you have the option to use it.
47-
* ```startAnalog(pin, callback)``` and ```stopAnalog(pin, callback)``` function added to start/stop analog output on pin.
48-
* __All callbacks now follow ```callback(err, resp)``` format as per NodeJs standards. This is a major BC break in v1.0.0. The previos format was ```callback(resp)```__
49-
* ```serialOpen``` and ```i2cOpen``` should now be used as ```serial.open``` and ```i2c.open```. Please check docs forlder for examples on this.
50-
* Any serial or I2C capes are no longer required if you use OctalBoneScript. Just using above serial and I2C functions will be sufficient.
51-
52-
5330
We encourage you to report issues rightaway if you face any. We will try our best to be of help.

0 commit comments

Comments
 (0)