Permalink
Browse files

Converted documentation to Markdown

  • Loading branch information...
1 parent e6b878c commit 1116376077a0b6b96d867726e9f9ae9e622b2be1 @njh committed Sep 25, 2011
Showing with 53 additions and 51 deletions.
  1. +0 −5 NEWS
  2. +7 −0 NEWS.md
  3. +0 −36 README
  4. +42 −0 README.md
  5. +4 −10 Rakefile
View
@@ -1,5 +0,0 @@
-= Matrix Orbital GLK Ruby Gem
-
-== MatrixOrbital-GLK Version 0.0.1 (2008-09-20)
-
-Initial Release.
View
@@ -0,0 +1,7 @@
+Matrix Orbital GLK Ruby Gem
+===========================
+
+Version 0.0.1 (2008-09-20)
+--------------------------
+
+Initial Release.
View
@@ -1,36 +0,0 @@
-== MatrixOrbital::GLK
-
-MatrixOrbital::GLK is a ruby gem for controlling
-the GLK serial of LCD screens made by Matrix Orbital.
-
-For more information about GLK series MatrixOrbital displays, please visit:
-http://www.matrixorbital.ca/products/glk_Series/
-
-Please note that I am not an employee and have nothing to do with MatrixOrbital,
-other than being a happy customer.
-
-RubyForge Project Page http://rubyforge.org/projects/matrixorbital/
-
-
-== Installing
-
-You may get the latest stable version from Rubyforge. Source gems are also available.
-
- $ gem install matrixorbital-glk
-
-
-=== Loading matrixorbital-glk gem Itself
-
-You have installed the gem already, yeah?
-
- require 'rubygems'
- require 'matrixorbital/glk'
-
-
-== Contact
-
-Author:: Nicholas J Humfrey
-Email:: njh@aelius.com
-Home Page:: http://www.aelius.com/njh/
-License:: Distributes under the same terms as Ruby
-
View
@@ -0,0 +1,42 @@
+MatrixOrbital::GLK
+==================
+
+MatrixOrbital::GLK is a ruby gem for controlling
+the GLK serial of LCD screens made by Matrix Orbital.
+
+For more information about GLK series MatrixOrbital displays, please visit:
+http://www.matrixorbital.ca/products/glk_Series/
+
+Please note that I am not an employee and have nothing to do with MatrixOrbital,
+other than being a happy customer.
+
+
+Installing
+----------
+
+You may get the latest stable version from rubygems.org
+
+ $ gem install matrixorbital-glk
+
+
+Loading matrixorbital-glk gem
+-----------------------------
+
+ require 'rubygems'
+ require 'matrixorbital/glk'
+
+Resources
+---------
+
+* Github page: http://github.com/njh/ruby-matrixorbital-glk
+* Documentation: http://rdoc.info/github/njh/ruby-matrixorbital-glk/master/frames
+* Matrix Orbital Manuals: http://www.matrixorbital.ca/manuals/GLK_Series/
+
+
+Contact
+-------
+
+* Author: Nicholas J Humfrey
+* Email: njh@aelius.com
+* Home Page: http://www.aelius.com/njh/
+* License: Distributes under the same terms as Ruby
View
@@ -16,16 +16,15 @@ spec = Gem::Specification.new do |s|
s.version = VERS
s.author = "Nicholas J Humfrey"
s.email = "njh@aelius.com"
- s.homepage = "http://matrixorbital.rubyforge.org"
+ s.homepage = "http://github.com/njh/ruby-matrixorbital-glk"
s.platform = Gem::Platform::RUBY
s.summary = "A ruby gem to interface Matrix Orbital's GLK series of LCD Screens."
- s.rubyforge_project = "matrixorbital"
s.files = FileList["Rakefile", "lib/matrixorbital/glk.rb", "examples/*"]
s.require_path = "lib"
# rdoc
s.has_rdoc = true
- s.extra_rdoc_files = ["README", "NEWS", "COPYING"]
+ s.extra_rdoc_files = ["README.md", "NEWS.md", "COPYING"]
# Dependencies
s.add_dependency "rake"
@@ -73,11 +72,6 @@ Rake::RDocTask.new("rdoc") { |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = "Matrix Orbital GLK Documentation"
rdoc.options << '--line-numbers' << '--inline-source'
- rdoc.main = "README"
- rdoc.rdoc_files.include("README", "NEWS", "COPYING", "lib/matrixorbital/glk.rb")
+ rdoc.main = "README.md"
+ rdoc.rdoc_files.include("README.md", "NEWS.md", "COPYING", "lib/matrixorbital/glk.rb")
}
-
-desc "Upload rdoc to rubyforge"
-task :upload_rdoc => [:rdoc] do
- sh %{/usr/bin/scp -r -p rdoc/* matrixorbital.rubyforge.org:/var/www/gforge-projects/matrixorbital}
-end

0 comments on commit 1116376

Please sign in to comment.