README fix -- avoid recommending /opt/local for install
authorpixar-oss <pixar-oss@users.noreply.github.com>
Fri, 12 Jan 2024 18:38:25 +0000 (10:38 -0800)
committerpixar-oss <pixar-oss@users.noreply.github.com>
Fri, 12 Jan 2024 18:42:31 +0000 (10:42 -0800)
(Internal change: 2310922)

README.md

index 20c77c1cbda18301d3f73a8007fb6a1ed5c4faa6..89057cddec0b7c2325faaef30fe36c66614a0c2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -111,18 +111,22 @@ You can download source code archives from [GitHub](https://www.github.com/Pixar
 
 ```
 > git clone https://github.com/PixarAnimationStudios/OpenUSD
-Cloning into 'USD'...
+Cloning into 'OpenUSD'...
 ```
 
 #### 3. Run the script
 
+Run the build_usd.py script to build and install USD. Note that the build script 
+is structured with an out-of-source build in mind -- installing a build into the  
+directory where the repository was cloned is untested. 
+
 ##### Linux:
 
 For example, the following will download, build, and install USD's dependencies,
-then build and install USD into `/usr/local/USD`.
+then build and install USD into `/path/to/my_usd_install_dir`.
 
 ```
-> python USD/build_scripts/build_usd.py /usr/local/USD
+> python USD/build_scripts/build_usd.py /path/to/my_usd_install_dir
 ```
 
 ##### MacOS:
@@ -131,10 +135,10 @@ In a terminal, run `xcode-select` to ensure command line developer tools are
 installed. Then run the script.
 
 For example, the following will download, build, and install USD's dependencies,
-then build and install USD into `/opt/local/USD`.
+then build and install USD into `/path/to/my_usd_install_dir`.
 
 ```
-> python USD/build_scripts/build_usd.py /opt/local/USD
+> python USD/build_scripts/build_usd.py /path/to/my_usd_install_dir
 ```
 
 ##### Windows:
@@ -146,10 +150,10 @@ command prompt and not the 32-bit (x86) command prompt.
 See https://docs.microsoft.com/en-us/cpp/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line for more details.
 
 For example, the following will download, build, and install USD's dependencies,
-then build and install USD into `C:\USD`.
+then build and install USD into `C:\path\to\my_usd_install_dir`.
 
 ```
-C:\> python USD\build_scripts\build_usd.py "C:\USD"
+C:\> python USD\build_scripts\build_usd.py "C:\path\to\my_usd_install_dir"
 ```
 
 #### 4. Try it out