more README.rdoc formatting

vertiginous · Sep 18, 2009 · 153bd60 · 153bd60
1 parent f14dfa9
commit 153bd60
Showing 1 changed file with 93 additions and 29 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -30,7 +30,7 @@ Only works on MRI at present.
 
 == SYNOPSIS:
 
-    C:\>pik help commands
+  C:\>pik help commands
 
       add             Adds another ruby location to pik.
       checkup|cu      Checks your environment for current Ruby best practices.
@@ -44,36 +44,100 @@ Only works on MRI at present.
       run             Runs command with all version of ruby that pik is aware of.
       switch|sw|use   Switches to another Ruby version.
 
-For help on a particular command, use 'pik help COMMAND'.
+  For help on a particular command, use 'pik help COMMAND'.
 
-Example:
+== EXAMPLES:
 
-    C:\>pik run "gem in hpricot --no-ri --no-rdoc"
+pik add
-     == Running with 185: ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32] ==
+
-    Successfully installed hpricot-0.8.1-x86-mswin32
+  C:\>ruby -v
-    1 gem installed
+  ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]
-
+
-     == Running with 186: ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32] ==
+  C:\>pik add
-    Successfully installed hpricot-0.8.1-x86-mswin32
+  Adding:  186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]'
-    1 gem installed
+   Located at:  c:/ruby/186-p368-mingw32/bin
-
+
-     == Running with 186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32] == 
+  C:\>pik add C:\ruby\191-p243-mingw32\bin
-    Building native extensions.  This could take a while...
+  Adding:  191: ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32]'
-    Successfully installed hpricot-0.8.1
+   Located at:  C:/ruby/191-p243-mingw32/bin
-    1 gem installed
+
-
+pik list
-     == Running with 191: ruby 1.9.1p0 (2009-01-30 revision 21907) [i386-mingw32] == 
+
-    Building native extensions.  This could take a while...
+  C:\>pik list
-    ERROR:  Error installing hpricot:
+  185: ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32]
-            ERROR: Failed to build gem native extension.
+  186: ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32]
-
+  186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32] *
-    ... Errors because I haven't added the devkit ...
+  191: ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32]
-
+  191: ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32]
-     == Running with 191: ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32] == 
+
-    Building native extensions.  This could take a while...
+or
-    Successfully installed hpricot-0.8.1
+
-    1 gem installed
+  C:\>pik list -v
-
+  185: ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32]
+       path: C:/ruby/185-p012-mswin32/bin
+
+  186: ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32]
+       path: C:/ruby/186-p287-mswin32/bin
+
+  186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32] *
+       path: C:/ruby/186-p368-mingw32/bin
+
+  191: ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32]
+       path: C:/ruby/191-p129-mingw32/bin
+
+  191: ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32]
+       path: C:/ruby/191-p243-mingw32/bin
+
+pik switch
+
+  C:\>pik switch 191 p129
+   == Switching to ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32] ==
+
+or
+
+  C:\>pik sw 185
+   == Switching to ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32] ==
+
+or
+
+  C:\>pik use 186 ms
+   == Switching to ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32] ==
+
+or
+
+  C:\>pik 191 p2
+   == Switching to ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32] ==
+
+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
+
 
 == REQUIREMENTS: