Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Updating documentation for windows installer & fixed casing inconsistencies. #137

Merged
merged 2 commits into from

3 participants

@indigo0086

No description provided.

indigo0086 added some commits
@indigo0086 indigo0086 Add additional instructions for msi install
* Added the section specifying that HOME or PIK_HOME need to be set
* Made casing of 'pik' referenced in the documentation consistent with
project page casing
4db0c04
@indigo0086 indigo0086 Fixed documentation error 08b4b35
@luislavena luislavena merged commit 22a028c into from
@luislavena
Collaborator

Thank you, I've merged your changes in 22a028c

@Dynamite83 Dynamite83 commented on the diff
README.rdoc
@@ -91,7 +91,9 @@ So I run:
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.
+The MSI installer currently doesn't install the needed files to use pik from Git Bash.
+
+If you install pik using the msi you must set the 'HOME' or 'PIK_HOME' environment variable to the directory pik installs to, ususally the path specified in %USERPROFILE%.
If you want to install to a directory that's not in your path, you can check the box to have the installer add it to the path for you (this will only work if you're an adminstrator). After that, you should be ready to run pik.

ty very much 4 the tips

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jun 22, 2012
  1. @indigo0086

    Add additional instructions for msi install

    indigo0086 authored
    * Added the section specifying that HOME or PIK_HOME need to be set
    * Made casing of 'pik' referenced in the documentation consistent with
    project page casing
  2. @indigo0086

    Fixed documentation error

    indigo0086 authored
This page is out of date. Refresh to see the latest.
Showing with 5 additions and 3 deletions.
  1. +5 −3 README.rdoc
View
8 README.rdoc
@@ -12,7 +12,7 @@ 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.
C:\>pik help commands
@@ -32,7 +32,7 @@ Pik is a tool to manage multiple versions of ruby on Windows. It can be used fr
ruby|rb Runs ruby with all versions that pik is aware of.
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.
+ uninstall|unin Deletes a ruby version from the filesystem and removes it from pik.
update|up updates pik.
use Switches ruby versions by name.
@@ -91,7 +91,9 @@ So I run:
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.
+The MSI installer currently doesn't install the needed files to use pik from Git Bash.
+
+If you install pik using the msi you must set the 'HOME' or 'PIK_HOME' environment variable to the directory pik installs to, ususally the path specified in %USERPROFILE%.
If you want to install to a directory that's not in your path, you can check the box to have the installer add it to the path for you (this will only work if you're an adminstrator). After that, you should be ready to run pik.

ty very much 4 the tips

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.