Permalink
Browse files

Converted to README.md

Other changes
  • Loading branch information...
1 parent 90c696b commit cfa663d4b55b168b268488ff18c82a92589fd4b7 @hparra committed Nov 4, 2013
Showing with 28 additions and 23 deletions.
  1. +1 −2 MANIFEST
  2. +26 −20 README → README.md
  3. +1 −1 serialport.gemspec
View
@@ -1,9 +1,8 @@
CHANGELOG
MANIFEST
-README
+README.md
Rakefile
serialport.gemspec
-VERSION
ext/native/extconf.rb
ext/native/posix_serialport_impl.c
ext/native/serialport.c
View
@@ -1,28 +1,28 @@
------Ruby/SerialPort-----
+# Ruby/SerialPort
--- Description --
+[![Build Status](https://travis-ci.org/hparra/ruby-serialport.png?branch=v1.2.2)](https://travis-ci.org/hparra/ruby-serialport)
-Ruby/SerialPort is a Ruby library that provides a class for using
-RS-232 serial ports. This class also contains low-level functions to
-check and set the current state of the signals on the line.
+## Description
-The native Windows version of this library supports Microsoft's Visual C++, Borland's C++, and MinGW compilers.
+Ruby/SerialPort is a Ruby library that provides a class for using RS-232 serial ports. This class also contains low-level functions to check and set the current state of the signals on the line.
--- Installation --
+The native Windows version of this library supports the Microsoft Visual C++, Borland C++, and MinGW compilers.
-Then you can install the gem as normal:
- sudo gem install serialport
+## Installation
--- Testing --
+Install the gem as normal: `sudo gem install serialport`
-* test/miniterm.rb
+## Testing
-Ruby's copy of miniterm.c !
+Use Ruby's version of miniterm: `ruby test/miniterm.rb`
+## API
--- API --
+Run `rdoc` or see <http://rubydoc.info/gems/serialport/SerialPort>
- **** Class SerialPort, Parent IO ****
+*The original documentation below specifies values returned by methods. See [Issue #45](https://github.com/hparra/ruby-serialport/issues/45)*
+
+ **** Class SerialPort, Parent IO ****
** Class constants **
@@ -142,12 +142,18 @@ Ruby's copy of miniterm.c !
Note: Under Windows, rts() and dtr() are not implemented.
--- License --
+## Issues
+
+See <https://github.com/hparra/ruby-serialport/issues>
+
+## License
GPL
-Guillaume Pierronnet <moumar@netcourrier.com>
-Alan Stern <stern@rowland.harvard.edu>
-Tobin Richard <tobin.richard@gmail.com>
-Hector Parra <hector@hectorparra.com>
-Ryan C. Payne <rpayne-oss@bullittsystems.com>
+## Authors
+
+* Guillaume Pierronnet <moumar@netcourrier.com>
+* Alan Stern <stern@rowland.harvard.edu>
+* Tobin Richard <tobin.richard@gmail.com>
+* Hector Parra <hector@hectorparra.com>
+* Ryan C. Payne <rpayne-oss@bullittsystems.com>
View
@@ -18,5 +18,5 @@ Gem::Specification.new do |s|
s.files = `git ls-files`.split($\)
s.extensions = "ext/native/extconf.rb"
s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
- s.extra_rdoc_files = ["LICENSE", "README"]
+ s.extra_rdoc_files = ["LICENSE", "README.md"]
end

0 comments on commit cfa663d

Please sign in to comment.