Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Josep M. Bach committed Jun 17, 2011
1 parent 67db2b9 commit 37a1a39
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 28 deletions.
27 changes: 0 additions & 27 deletions Rakefile
Expand Up @@ -14,33 +14,6 @@ YARD::Rake::YardocTask.new(:docs) do |t|
t.files = ['lib/**/*.rb'] t.files = ['lib/**/*.rb']
t.options = ['-m', 'markdown', '--no-private', '-r', 'Readme.md', '--title', 'Rexpl documentation'] t.options = ['-m', 'markdown', '--no-private', '-r', 'Readme.md', '--title', 'Rexpl documentation']
end end

site = 'doc'
source_branch = 'master'
deploy_branch = 'gh-pages'

desc "generate and deploy documentation website to github pages"
multitask :pages do
puts ">>> Deploying #{deploy_branch} branch to Github Pages <<<"
require 'git'
repo = Git.open('.')
puts "\n>>> Checking out #{deploy_branch} branch <<<\n"
repo.branch("#{deploy_branch}").checkout
(Dir["*"] - [site]).each { |f| rm_rf(f) }
Dir["#{site}/*"].each {|f| mv(f, "./")}
rm_rf(site)
puts "\n>>> Moving generated site files <<<\n"
Dir["**/*"].each {|f| repo.add(f) }
repo.status.deleted.each {|f, s| repo.remove(f)}
puts "\n>>> Commiting: Site updated at #{Time.now.utc} <<<\n"
message = ENV["MESSAGE"] || "Site updated at #{Time.now.utc}"
repo.commit(message)
puts "\n>>> Pushing generated site to #{deploy_branch} branch <<<\n"
repo.push
puts "\n>>> Github Pages deploy complete <<<\n"
repo.branch("#{source_branch}").checkout
end

task :doc => [:docs] task :doc => [:docs]


desc "Generate and open class diagram (needs Graphviz installed)" desc "Generate and open class diagram (needs Graphviz installed)"
Expand Down
21 changes: 21 additions & 0 deletions Readme.md
Expand Up @@ -44,3 +44,24 @@ Don't panic. You always have your friends pen and paper ready to help you out,
Read through the source code, and knowing what each instruction does, try to Read through the source code, and knowing what each instruction does, try to
follow along and draw what the stack looks like at each step (does that sound follow along and draw what the stack looks like at each step (does that sound
familiar to you?). Or just fire up **rexpl**. familiar to you?). Or just fire up **rexpl**.

## Resources

Documentation is online here:

* [Rexpl documentation](http://rdoc.info/github/txus/rexpl/master/frames)

##Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
If you want to have your own version, that is fine but bump version
in a commit by itself I can ignore when I pull.
* Send me a pull request. Bonus points for topic branches.

## Copyright

Copyright (c) 2010 Josep M. Bach. See LICENSE for details.
2 changes: 1 addition & 1 deletion lib/rexpl.rb
@@ -1,6 +1,6 @@
# rexpl is an interactive bytecode console for the Rubinius VM. # rexpl is an interactive bytecode console for the Rubinius VM.
# #
# **rexpl** is a sandbox to experiment and play with the [Rubinius](http:://rubini.us) # **rexpl** is a sandbox to experiment and play with the [Rubinius](http://rubini.us)
# Virtual Machine and its bytecode instructions. It comes wrapped in a REPL # Virtual Machine and its bytecode instructions. It comes wrapped in a REPL
# (Read-Eval-Print Loop) à la IRB, so that anytime you can open a terminal, # (Read-Eval-Print Loop) à la IRB, so that anytime you can open a terminal,
# fire up **rexpl**, and start playing with instant feedback. # fire up **rexpl**, and start playing with instant feedback.
Expand Down

0 comments on commit 37a1a39

Please sign in to comment.