Permalink
Browse files

updated readme.rdoc

  • Loading branch information...
1 parent ea8fb72 commit 43225bf6a8298a5d742d7d7401c3017cdddb8e7c @vertiginous committed Oct 6, 2009
Showing with 94 additions and 37 deletions.
  1. +94 −37 README.rdoc
View
@@ -16,29 +16,32 @@ Or to put it another way
You have to tell it where your different ruby versions live using
'pik add'. Then you can change to one by using 'pik switch'.
-It also has a "sort of" multiruby functionality in 'pik run'.
+It also supports running commands/code with all versions configured.
+
+ pik run : Runs commands on the command line
+ pik ruby : Runs using the ruby interpreter for each version (ruby.exe, jruby.bat, ir.exe)
+ pik gem : Runs using the gem command for each version (gem.bat, igem.bat)
== FEATURES/PROBLEMS:
-Changes are to the open cmd session only.
-
-Only works on MRI at present, support for JRuby, and maybe IronRuby are planned.
== SYNOPSIS:
- C:\>pik help commands
+ >pik help commands
add Adds another ruby location to pik.
checkup|cu Checks your environment for current Ruby best practices.
config Adds/modifies configuration options.
default switches back to the default settings
+ gem Runs the gem command with all versions that pik is aware of.
gemsync Duplicates gems from the current version to the one specified.
help Displays help information.
implode Removes your pik configuration.
list|ls Lists ruby versions that pik is aware of.
remove|rm Removes a ruby location from pik.
- run Runs command with all version of ruby that pik is aware of.
+ ruby|rb Runs ruby with all versions that pik is aware of.
+ run Runs command with all versions of ruby that pik is aware of.
switch|sw|use Switches ruby versions based on patterns.
For help on a particular command, use 'pik help COMMAND'.
@@ -49,13 +52,39 @@ Windows, more than one version of Ruby (otherwise, what's the point?) and Rubyge
== INSTALL:
-1. gem install pik
-2. pik add # adds your current ruby's bin dir
-3. pik add path\to\some\other\ruby\bin # for another version
-4. repeat step 3 for each version of ruby you have, or use 'pik add -i' for super-fancy interactive mode!
-5. pik run "gem install vertiginous-pik"
-
-
+1. If you've used a version previous to this one, you'll need to uninstall them.
+ Don't worry, this will leave your pik config intact.
+
+ pik run "gem uninstall pik"
+
+2. Install the pik gem
+
+ gem install pik
+
+3. You need to install pik to a location that's in your path, but someplace other than your ruby\bin dir
+
+ pik_install C:\some\other\path
+
+4. Add all the versions of ruby that you want to use with pik
+
+ >pik add
+ Adding: 186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]
+ Located at: c:/ruby/186-p368-mingw32/bin
+
+ >pik add C:\ruby\IronRuby-091\bin
+ Adding: 091: IronRuby 0.9.1.0 on .NET 2.0.0.0
+ Located at: C:/ruby/IronRuby-091/bin
+
+ >pik add C:\ruby\jruby-1.4.0RC1\bin
+ Adding: 140: jruby 1.4.0RC1 (ruby 1.8.7 patchlevel 174) (2009-09-30 80c263b) (Java HotSpot(TM) Client VM 1.6.0_14) [x86-java]
+ Located at: C:/ruby/jruby-1.4.0RC1/bin
+
+Note:
+
+ When using IronRuby, I have found that is necesary to configure the GEM_HOME env. variable to a directory
+ inside of the IronRuby lib:
+
+ pik config gem_home=C:\ruby\ironruby-091\lib\ironruby\gems\1.8
== EXAMPLES:
@@ -124,30 +153,58 @@ or
C:\>pik default
== Switching to ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32] ==
-pik run
-
- C:\>pik run "gem in hpricot"
- == Running with ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32] ==
- Successfully installed hpricot-0.8.1-x86-mswin32
- 1 gem installed
-
- == Running with ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32] ==
- Successfully installed hpricot-0.8.1-x86-mswin32
- 1 gem installed
-
- == Running with ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32] ==
- Building native extensions. This could take a while...
- Successfully installed hpricot-0.8.1
- 1 gem installed
-
- == Running with ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32] ==
- Building native extensions. This could take a while...
- Successfully installed hpricot-0.8.1
- 1 gem installed
-
- == Running with ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32] ==
- Successfully installed hpricot-0.8.1
- 1 gem installed
+pik run # there
+
+ >tools\pik gem install runt -v
+ Running with IronRuby 0.9.0.0 on .NET 2.0.0.0
+ igem.bat install runt
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with IronRuby 0.9.1.0 on .NET 2.0.0.0
+ igem.bat install runt
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with jruby 1.3.1 (ruby 1.8.6p287) (2009-06-15 2fd6c3d) (Java HotSpot(TM) Client VM 1.6.0_14) [x86-java]
+ gem.bat install runt
+ JRuby limited openssl loaded. gem install jruby-openssl for full support.
+ http://wiki.jruby.org/wiki/JRuby_Builtin_OpenSSL
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with jruby 1.4.0RC1 (ruby 1.8.7 patchlevel 174) (2009-09-30 80c263b) (Java HotSpot(TM) Client VM 1.6.0_14) [x86-java]
+ gem.bat install runt
+ JRuby limited openssl loaded. gem install jruby-openssl for full support.
+ http://jruby.kenai.com/pages/JRuby_Builtin_OpenSSL
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32]
+ gem.bat install runt
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32]
+ gem.bat install runt
+ "C:\\Documents and Settings\\gthiesfeld/.gem/ruby/1.8/cache/runt-0.7.0.gem"
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]
+ gem.bat install runt
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32]
+ gem.bat install runt
+ Successfully installed runt-0.7.0
+ 1 gem installed
+
+ Running with ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32]
+ gem.bat install runt
+ Successfully installed runt-0.7.0
+ 1 gem installed
== LICENSE:

0 comments on commit 43225bf

Please sign in to comment.