Permalink
Browse files

readme

  • Loading branch information...
1 parent 8cbad12 commit 6a798d0e59ca6df837ca22ef87594948fb53223e @nofxx nofxx committed Apr 12, 2012
Showing with 12 additions and 2 deletions.
  1. +12 −2 README.md
View
@@ -1,8 +1,9 @@
-# ruby-buspirate - Ruby interface to Bus Pirate (via binary mode)
+# BusPirate - Ruby interface to Bus Pirate (via binary mode)
## Description
-Ruby class (and gem in the future) to access [The Bus Pirate](http://dangerousprototypes.com/docs/Bus_Pirate) in binary mode
+Ruby class (and gem in the future) to access [The Bus Pirate](http://dangerousprototypes.com/docs/Bus_Pirate) in binary mode.
+
## Features
@@ -22,10 +23,12 @@ Create a BusPirate instance:
pirate = BusPirate.new('/dev/port', bauds, bits, stopbit, parity)
+
Linux example (115200b 8-N-1):
pirate = BusPirate.new('/dev/ttyACM0')
+
Select Mode:
Mode::SPI
@@ -39,11 +42,18 @@ Select Mode:
Have fun!
+
+## Examples
+
+Check out the examples/ folder for some action.
+
+
## Dependencies
* serialport
* a Bus Pirate ^^
+
## License
Copyright (c) 2011, *Prof. MAAD* aka Max Wolter

0 comments on commit 6a798d0

Please sign in to comment.