From 672afc96fa9d18396e6ee19c98077d942de7324b Mon Sep 17 00:00:00 2001 From: poor Date: Fri, 15 Sep 2017 15:09:18 +0200 Subject: [PATCH 1/2] Install instructions revised Install instructions proposal (formatting, linux, manual link to `houdini.env`, forward slashes on windows, optional use of provided environment file) --- README.md | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 56548fdd..ecd685c4 100644 --- a/README.md +++ b/README.md @@ -8,41 +8,45 @@ NOTE: This is in-progress. Please file an [Issue](https://github.com/sideeffects Also, if you forked the respository and suddenly it stopped pulling, that's due to the link changing from [https://github.com/sideeffects/GameDevelopmentShelf/](https://github.com/sideeffects/GameDevelopmentShelf/) to [https://github.com/sideeffects/GameDevelopmentToolset/](https://github.com/sideeffects/GameDevelopmentToolset/). Github appears to forward traffic to the new link, but here's a little FYI just incase. -# Installation - - - -## Instructions - Method 1 -Download the repository using the green Clone or Download Button and unzip contents into the following folders depending on your operating system: -Windows - - C:\Users\[username]\Documents\houdini[ver#] - -OSX +# Installation - /Users/[username]/Library/Preferences/houdini/[ver#] +## Instructions - Method 1 (User Preferences) -Be sure to merge as needed! If you're copying and not cloning, the files shouldn't overwrite anything that doesn't involve the toolset. +Download the repository using the green *Clone* or *Download* Button and unzip contents *(otls, scripts, toolbar etc.)* into the following folders depending on your operating system: -## Instructions - Method 2 -Download the repository using the green Clone or Download Button and unzip contents into the folder of your choosing + C:\Users\[username]\Documents\houdini[ver#]\ # Windows + /Users/[username]/Library/Preferences/houdini/[ver#]/ # OSX + /home//houdini[ver#]/ # Linux -Edit the houdini.env file found at the topmost directory +Be sure to merge as needed! *If you're copying and not cloning, the files shouldn't overwrite anything that doesn't involve the toolset.* -Modify the line HOUDINI_PATH = C:\PATH\TO\YOUR\DIRECTORY;& -Into something like HOUDINI_PATH = C:\Users\Luiz\Documents\GameDevelopmentToolset;& +## Instructions - Method 2 (Custom Directory) -Copy the houdini.env file into the following folders depending on your operating system: +1. *Download* or *Clone* the repository and unzip contents into a folder of your choice, e.g.: + + C:\Users\\Documents\houdini[ver#]\ # Windows + /Users//Library/Preferences/houdini/[ver#]/ # OSX + /home//houdini[ver#]/ # Linux + +1. Open up your [`houdini.env`](http://www.sidefx.com/docs/houdini/basics/config_env#setting-environment-variables) file and add the path of your custom folder to `HOUDINI_PATH` environment variable, please note that even on a Windows machine *forward slashes* are required: -Windows + HOUDINI_PATH = "C:/Users//Documents/houdini[ver#]/;&" # Windows + HOUDINI_PATH = "/Users//Library/Preferences/houdini/[ver#]/;&" # OSX + HOUDINI_PATH = "/home//houdini[ver#]/;&" # Linux - C:\Users\[username]\Documents\houdini[ver#] + If `HOUDINI_PATH` already has an entry, you can concatenate both paths: + + HOUDINI_PATH = "PATH/TO/DIRECTORY; PATH/TO/ANOTHER/DIRECTORY; &" + + + In case [`houdini.env`](http://www.sidefx.com/docs/houdini/basics/config_env#setting-environment-variables) file doesn’t already exist, you can copy the provided `houdini.env` file of this repository into the following folders depending on your operating system: -OSX + C:\Users\[username]\Documents\houdini[ver#] # Windows + /Users/[username]/Library/Preferences/houdini/[ver#] # OSX + /home//houdini[ver#] # Linux - /Users/[username]/Library/Preferences/houdini/[ver#] # What's Changed? Hi, my name is Luiz Kruel and I have taken over the github from Steven B. who is now working in production. A few of the SideFX TAs (TDs) will also be contributing example files and tools. From 8061ea378bda79c325e2f3dfefb69128649a0866 Mon Sep 17 00:00:00 2001 From: poor Date: Tue, 19 Sep 2017 14:53:25 +0200 Subject: [PATCH 2/2] spaces removed in HOUDINI PATH assignment example --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ecd685c4..1ecc75df 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,9 @@ Be sure to merge as needed! *If you're copying and not cloning, the files should HOUDINI_PATH = "/Users//Library/Preferences/houdini/[ver#]/;&" # OSX HOUDINI_PATH = "/home//houdini[ver#]/;&" # Linux - If `HOUDINI_PATH` already has an entry, you can concatenate both paths: + If `HOUDINI_PATH` already has an entry, you can concatenate the paths (separated by a semicolon): - HOUDINI_PATH = "PATH/TO/DIRECTORY; PATH/TO/ANOTHER/DIRECTORY; &" + HOUDINI_PATH = "PATH/TO/DIRECTORY;PATH/TO/ANOTHER/DIRECTORY;&" In case [`houdini.env`](http://www.sidefx.com/docs/houdini/basics/config_env#setting-environment-variables) file doesn’t already exist, you can copy the provided `houdini.env` file of this repository into the following folders depending on your operating system: