Skip to content

Commit 13f8384

Browse files
committed
cleaned up README.md
Signed-off-by: Akash Manohar J <[email protected]>
1 parent a28494d commit 13f8384

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Arduino ruby gem
22

3-
Arduino is a prototyping API for Arduino in Ruby. Helps prototype Arduino programs quickly from the computer, without the need to burn to the board frequently.
3+
This gem is a prototyping API for Arduino in Ruby. Helps prototype Arduino programs quickly from the computer, without the need to burn to the board frequently.
44

55
#### Setup:
66
1. Install the gem: `gem install arduino`
7-
2. Load arduino.pde onto your Arduino dev board (just once and for all).
7+
2. Load [arduino.pde](https://github.com/SingAlong/arduino/raw/master/arduino.pde) onto your Arduino dev board (just once and for all).
88
3. Import the arduino gem: `require "arduino"`
99

1010
## Methods
1111

12-
#### Initializing:
12+
### Initializing:
1313

1414
#Arduino.new(port, baudrate)
1515
board = Arduino.new("/dev/ttyUSB1")
1616

1717
Port is something like "/dev/ttyUSB0" on linux and COM*x* (COM1/COM2) on windows. Baudrate is optional. It is 115200 by default.
1818

19-
#### Setting output pins
19+
### Setting output pins
2020

2121
The output pins must be set explicitly.
2222

@@ -43,25 +43,25 @@ The output pins must be set explicitly.
4343

4444
## Usage example
4545

46-
# This is the blink program.
46+
# This is the blink program.
4747

48-
require "arduino"
48+
require "arduino"
4949

50-
#specify the port Baudrate is optional and set to 115200 by default
51-
myBoard = Arduino.new("/dev/ttyUSB1")
50+
#specify the port Baudrate is optional and set to 115200 by default
51+
myBoard = Arduino.new("/dev/ttyUSB1")
5252

53-
#declare output pins
54-
myBoard.output(13)
53+
#declare output pins
54+
myBoard.output(13)
5555

56-
#perform operations
57-
10.times do
58-
myBoard.setHigh(13)
59-
sleep(1)
60-
myBoard.setLow(13)
61-
sleep(1)
62-
end
56+
#perform operations
57+
10.times do
58+
myBoard.setHigh(13)
59+
sleep(1)
60+
myBoard.setLow(13)
61+
sleep(1)
62+
end
6363

64-
# Developed for the love of programming by
64+
# Developed for the love of creating stuff by
6565
> &copy; 2010 Akash Manohar <[email protected]>
6666
> under the MIT License
6767

0 commit comments

Comments
 (0)