Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

readme updates

  • Loading branch information...
commit d37f7d82949c2640f5c53d018eff3d061604be63 1 parent d8670ed
@vertiginous authored
Showing with 12 additions and 11 deletions.
  1. +12 −11 README.rdoc
View
23 README.rdoc
@@ -12,9 +12,9 @@ Gordon Thiesfeld gthiesfeld@gmail.com
== 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. \
+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
+ C:\>pik help commands
add Adds another ruby location to pik.
benchmark|bench Runs bencmarks with all versions that pik is aware of.
@@ -26,6 +26,7 @@ Pik is a tool to manage multiple versions of ruby on Windows. It can be used fr
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.
+ package Downloads and installs packages.
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.
@@ -37,24 +38,26 @@ Pik is a tool to manage multiple versions of ruby on Windows. It can be used fr
use Switches ruby versions by name.
For help on a particular command, use 'pik help COMMAND'.
+
== REQUIREMENTS:
* Windows
-* Development dependencies:
+* Development requirements:
ruby 1.8.7 p330: http://rubinstaller.org
- upx: http://upx.sourceforge.net/
rake: gem install rake
isolate: gem install isolate
exerb-mingw: http://vert.igino.us/2011/01/05/exerb-101-building-windows-executables-with-ruby/
-* Packaging dependencies:
+ upx (downloaded automatically, as needed): http://upx.sourceforge.net/
+
+* Packaging requirements:
- wix 3.5: http://wix.sourceforge.net/
+ wix 3.5(downloaded automatically, as needed): http://wix.sourceforge.net/
== INSTALL:
@@ -65,7 +68,7 @@ You can install pik via rubygems, or the Windows installer, or you can update pi
>gem install pik
...
- Successfully installed pik-0.2.6
+ Successfully installed pik-0.3.0
1 gem installed
After the gem is installed, you can use the 'pik_install' script to install the pik executable. Install pik to a location that's in your path, but someplace other than your ruby\bin dir. For instance, the directory C:\bin is in my path:
@@ -86,11 +89,9 @@ So I run:
=== Install pik using the installer
-If you want to install to a machine that doesn't have Ruby installed yet, you can download the latest msi file from github[http://github.com/vertiginous/pik/downloads]. Or, just run:
-
- >msiexec /i http://github.com/downloads/vertiginous/pik/pik-n.n.n.msi
+If you want to install to a machine that doesn't have Ruby installed yet, you can download the latest msi file from github[http://github.com/vertiginous/pik/downloads].
-The MSI installer currently doesn't install the needed files to use Pik from Git Bash. Also, there was a bug in the upgrade code in 0.2.7, so you should uninstall the current version before installing the new one.
+The MSI installer currently doesn't install the needed files to use Pik from Git Bash.
If you install to a directory that's not in your path, you'll need to add it to the path yourself. Microsoft has good instructions[http://support.microsoft.com/kb/310519] on that. After that, you should be ready to run pik.
Please sign in to comment.
Something went wrong with that request. Please try again.