virb 0.0.2 → 0.0.3

data/README.md

@@ -2,17 +2,20 @@
 
 Virb is an interactive Vim mode for IRB, Rails console, and Pry.
 
+![screen1](https://raw.github.com/danchoi/virb/master/images/virb1-sm.png)
+![screen2](https://raw.github.com/danchoi/virb/master/images/virb2-sm.png)
+
 ## Motivation
 
-The IRB is Ruby's interactive REPL. IRB is a very handy tool, but its
-text-editing capabilities are limited. Virb wraps an IRB session in a Vim
-session and gives you convenient ways to evaluate Ruby code from Vim.
+IRB is Ruby's interactive REPL. IRB is a very handy tool, but its text-editing
+capabilities are limited. Virb wraps an IRB session in a Vim session and gives
+you convenient ways to evaluate Ruby code from Vim.
 
 Virb inverts the approach taken by
 the [interactive_editor](https://github.com/jberkel/interactive_editor) gem and
 similar solutions which let you pop out into Vim from IRB and come back to IRB
 to see the results.  Virb keeps you in Vim at all times, calling IRB behind the
-scenes and fetching IBR's output to display inside Vim.
+scenes and fetching IRB's output to display inside Vim.
 
 ## Install
 
@@ -69,9 +72,13 @@ Put this in your Gemfile:
       gem 'virb'
     end
 
-and start Rails console as you do normally. You should see the Virb interface
-open, where you can interact with the Ralis console through a Vim buffer and
-see its output in the other Vim buffer.
+and start Rails console as you do normally, with `rails c`. You should see the
+Virb interface open, where you can interact with the Ralis console through a
+Vim buffer and see its output in the other Vim buffer.
+
+If you want to open a worksheet in Virb + Rails console, don't specify it on
+the command line. Open it from within Vim using `:e [file]` after the Virb
+session has started.
 
 If you want to use Virb with Pry and Rails console:
 
@@ -86,11 +93,23 @@ and start Rails console like this:
 
     VIRB=pry rails c
 
-
 ## Caveats
 
 The normal command line options for `irb` and `pry` do not work with `virb`.
 
+Also, `irb` extensions and `.irbrc` settings that introduce output coloring may
+garble the evaluated output in Virb. For best results, remove these extensions.
+
+## Issues
+
+Please report issues [on the GitHub issue tracker](https://github.com/danchoi/virb/issues).
+
+## Tip
+
+You may want try adding a Vim plugin called
+[ri.vim](https://github.com/danchoi/ri.vim) to perform
+Ruby documentation lookups from the Vim workspace. Virb and ri.vim are
+compatible, and written by the same author.
 
 ## Author
 

data/Rakefile

@@ -11,7 +11,7 @@ task :web => :build_webpage do
   puts "Building and pushing website"
   Dir.chdir "../project-webpages" do
     `scp out/virb.html zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
-    `rsync -avz out/images-virb zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/images zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
     `rsync -avz out/stylesheets zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
     `rsync -avz out/lightbox2 zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
   end

data/images/scaledown.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# scales an image file down to 75%
+
+# an ad hoc script that can be adapted for future uses
+
+# $1 name of an jpg image file 
+
+out=${1%.png}-sm.png
+echo "$1 -> $out"
+convert $1 -scale %75 $out

data/lib/virb/version.rb

@@ -1,3 +1,3 @@
 module Virb
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/virb.vim

@@ -43,6 +43,7 @@ wincmd p
 setlocal nu
 setlocal statusline=%!VirbStatusLine()
 command! -bar -range Virb :<line1>,<line2>call Virb()
+set ft=ruby
 
 " main execution function
 func! Virb() range

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies: []
 description: A Vim shell for irb and rails console
 email:
@@ -25,7 +25,10 @@ files:
 - Rakefile
 - bin/virb
 - bin/virb-pry
+- images/scaledown.sh
+- images/virb1-sm.png
 - images/virb1.png
+- images/virb2-sm.png
 - images/virb2.png
 - images/virb3.png
 - lib/virb.rb