Skip to content
Browse files

Readme in Markdown, moved the tutorial.

  • Loading branch information...
1 parent 6271ed9 commit c846f6d8c6336affb2e7285bb3ca1df17238edb3 @mvidner committed Oct 4, 2012
Showing with 12 additions and 16 deletions.
  1. +2 −0 .yardopts
  2. +10 −10 README → README.md
  3. +0 −6 Rakefile
  4. 0 doc/{tutorial/index.markdown → Tutorial.md}
View
2 .yardopts
@@ -1,4 +1,6 @@
lib/**/*.rb
-
+README.md
doc/Reference.md
doc/ex-*.rb
+doc/Tutorial.md
View
20 README → README.md
@@ -1,17 +1,17 @@
-= Ruby D-Bus README
+# Ruby D-Bus README
Ruby D-Bus provides an implementation of the D-Bus protocol such that the
D-Bus system can be used in the Ruby programming language.
-== Requirements
+## Requirements
- * Ruby 1.8.7 or 1.9
+- Ruby 1.8.7 or 1.9
-== Installation
+## Installation
- * gem install ruby-dbus
+- `gem install ruby-dbus`
-== Feature
+## Features
Ruby D-Bus currently supports the following features:
@@ -27,14 +27,14 @@ Ruby D-Bus currently supports the following features:
allows for introspection.
* Emitting signals on exported objects.
-== Usage
+## Usage
See some of the examples in the examples/ subdirectory of the tarball.
- Also, check out the included tutorial (in Markdown format) in doc/tutorial/
+ Also, check out the included tutorial (in Markdown format) in doc/Tutorial.md
or view it online on
- https://github.com/mvidner/ruby-dbus/blob/master/doc/tutorial/index.markdown .
+ <https://github.com/mvidner/ruby-dbus/blob/master/doc/Tutorial.md> .
-== License
+## License
Ruby D-Bus is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
View
6 Rakefile
@@ -54,9 +54,3 @@ Rake::RDocTask.new do |rd|
# rd.options << "--diagram"
# rd.options << "--all"
end
-
-desc "Render the tutorial in HTML"
-task :tutorial => "doc/tutorial/index.html"
-file "doc/tutorial/index.html" => "doc/tutorial/index.markdown" do |t|
- sh "markdown #{t.prerequisites[0]} > #{t.name}"
-end
View
0 doc/tutorial/index.markdown → doc/Tutorial.md
File renamed without changes.

0 comments on commit c846f6d

Please sign in to comment.
Something went wrong with that request. Please try again.