Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

readme cleanup

  • Loading branch information...
commit 110e9ad8749205781578574c165e825f9a59236f 1 parent 15f1d92
@vertiginous authored
Showing with 16 additions and 144 deletions.
  1. +16 −144 README.rdoc
View
160 README.rdoc
@@ -12,41 +12,41 @@ Gordon Thiesfeld
== DESCRIPTION:
-Pik is a tool to manage multiple versions of ruby on Windows. It can be used from the Windows command line (cmd.exe), Windows PowerShell, or Git Bash. I have yet to test on cygwin.
+Pik is a tool to manage multiple versions of ruby on Windows. It can be used from the Windows command line (cmd.exe), Windows PowerShell, or Git Bash. \
>pik help commands
-
+
add Adds another ruby location to pik.
benchmark|bench Runs bencmarks with all versions that pik is aware of.
config Adds/modifies configuration options.
- default Switches back to the default settings.
- devkit Configures devkit settings
+ default Switches to the default ruby.
gem Runs the gem command with all versions that pik is aware of.
- gemsync Synchronizes gems from the version specified to the current version.
help Displays help information.
implode Removes your pik configuration.
- info|checkup|cu Displays information about the current ruby version.
+ info Displays information about the current ruby version.
install|in Downloads and installs different ruby versions.
list|ls Lists ruby versions that pik is aware of.
rake Runs the rake command with all versions that pik is aware of.
+ refresh Refreshes the pik configuration file.
remove|rm Removes a ruby location from pik.
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.
- tag Adds the given tag to the current version.
- tags Runs the pik command against the given tags.
+ run|exec Executes shell command with all versions of ruby that pik is aware of.
+ system Switches back to initial system environment.
uninstall|unin Deletes a ruby version from the filesystem and removes it from Pik.
update|up updates pik.
- use|switch|sw Switches ruby versions based on patterns.
-
+ use Switches ruby versions by name.
+
For help on a particular command, use 'pik help COMMAND'.
== REQUIREMENTS:
-Windows
+* Windows
+
+* Build dependencies: exerb-mingw, highline, crown
-* Build dependencies: exerb-mingw, highline, hpricot, crown, upx, wix
+* Packaging dependencies upx, wix, uuid gem
-* Development dependencies: rake, cucumber, rspec, hoe, hoe-git, rack, rack-cache
+* Development dependencies: rake, cucumber, rspec, hoe, hoe-git
== INSTALL:
@@ -104,137 +104,9 @@ If you install to a directory that's not in your path, you'll need to add it to
from all of your ruby versions. Gem uninstall should do the trick.
-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
-
- Also, if you're using a version of JRuby older than 1.4.0RC2, you'll probably need to set the JAVA_HOME env
- variable.
-
- set JAVA_HOME=C:\Program Files\Java\jre6
-
-== EXAMPLES:
-
-pik add
-
- C:\>ruby -v
- ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]
-
- C:\>pik add
- Adding: 186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32]'
- Located at: c:/ruby/186-p368-mingw32/bin
-
- C:\>pik add C:\ruby\191-p243-mingw32\bin
- Adding: 191: ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32]'
- Located at: C:/ruby/191-p243-mingw32/bin
-
-pik list
-
- C:\>pik list
- 185: ruby 1.8.5 (2006-12-25 patchlevel 12) [i386-mswin32]
- 186: ruby 1.8.6 (2008-08-11 patchlevel 287) [i386-mswin32]
- 186: ruby 1.8.6 (2009-03-31 patchlevel 368) [i386-mingw32] *
- 191: ruby 1.9.1p129 (2009-05-12 revision 23412) [i386-mingw32]
- 191: ruby 1.9.1p243 (2009-07-16 revision 24175) [i386-mingw32]
-
-or
-
- 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] ==
+== MORE INFORMATION:
-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 # 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
+See the wiki for examples and documentation. If something isn't documented correctly or at all, feel free to fix it yourself, or let me know.
== LICENSE:
Please sign in to comment.
Something went wrong with that request. Please try again.