Skip to content

G
glslang
Commit 384b2070 by Cory Bloor
Options

Improve build instructions

- Mention that the instructions are written for Bash. - Quote the CMAKE_INSTALL_PREFIX to handle spaces in $(pwd). - Remove SSH clone instructions. Instructions on how to clone are for those unfamiliar with GitHub, so fewer options are better and SSH requires additional configuration to make work. - Replace ninja with make, because more people are familiar with it and we probably don't need to explain how to install it. Fixes #956. - Remove the section mentioning cygwin, as it's unclear and doesn't seem necessary. - Mention minimum language version in the Dependencies section. - Move `cd $BUILD_DIR` out of the Linux configuration section because it's needed on both platforms. Add a line about creating the build directory, too.
parent 6a14f780
Showing with 16 additions and 15 deletions
README.md
...@@ -57,20 +57,22 @@ branch. ...@@ -57,20 +57,22 @@ branch.
### Dependencies ### Dependencies
* A C++11 compiler
* [CMake][cmake]: for generating compilation targets. * [CMake][cmake]: for generating compilation targets.
* make: _Linux_, ninja is an alternative, if configured.
* [Python 2.7][python]: for executing SPIRV-Tools scripts. (Optional if not using SPIRV-Tools.) * [Python 2.7][python]: for executing SPIRV-Tools scripts. (Optional if not using SPIRV-Tools.)
* [bison][bison]: _optional_, but needed when changing the grammar (glslang.y). * [bison][bison]: _optional_, but needed when changing the grammar (glslang.y).
* [googletest][googletest]: _optional_, but should use if making any changes to glslang. * [googletest][googletest]: _optional_, but should use if making any changes to glslang.
### Build steps ### Build steps
The following steps assume a Bash shell. On Windows, that could be the Git Bash
shell or some other shell of your choosing.
#### 1) Check-Out this project #### 1) Check-Out this project
```bash ```bash
cd <parent of where you want glslang to be> cd <parent of where you want glslang to be>
# If using SSH
git clone git@github.com:KhronosGroup/glslang.git
# Or if using HTTPS
git clone https://github.com/KhronosGroup/glslang.git git clone https://github.com/KhronosGroup/glslang.git
``` ```
...@@ -89,28 +91,27 @@ spirv-tools with this: ...@@ -89,28 +91,27 @@ spirv-tools with this:
./update_glslang_sources.py ./update_glslang_sources.py
``` ```
For running the CMake GUI or Visual Studio with python dependencies, you will,
in addition to python within the cygwin environment, need a Windows [python][python]
installation, including selecting the `PATH` update.
#### 3) Configure #### 3) Configure
Assume the source directory is `$SOURCE_DIR` and Assume the source directory is `$SOURCE_DIR` and the build directory is
the build directory is `$BUILD_DIR`: `$BUILD_DIR`. First ensure the build directory exists, then navigate to it:
For building on Linux (assuming using the Ninja generator):
```bash ```bash
mkdir -p $BUILD_DIR
cd $BUILD_DIR cd $BUILD_DIR
```
For building on Linux:
cmake -GNinja -DCMAKE_BUILD_TYPE={Debug|Release|RelWithDebInfo} \ ```bash
-DCMAKE_INSTALL_PREFIX=`pwd`/install $SOURCE_DIR cmake -DCMAKE_BUILD_TYPE={Debug|Release|RelWithDebInfo} \
-DCMAKE_INSTALL_PREFIX="$(pwd)/install" $SOURCE_DIR
``` ```
For building on Windows: For building on Windows:
```bash ```bash
cmake $SOURCE_DIR -DCMAKE_INSTALL_PREFIX=`pwd`/install cmake $SOURCE_DIR -DCMAKE_INSTALL_PREFIX="$(pwd)/install"
# The CMAKE_INSTALL_PREFIX part is for testing (explained later). # The CMAKE_INSTALL_PREFIX part is for testing (explained later).
``` ```
...@@ -120,7 +121,7 @@ The CMake GUI also works for Windows (version 3.4.1 tested). ...@@ -120,7 +121,7 @@ The CMake GUI also works for Windows (version 3.4.1 tested).
```bash ```bash
# for Linux: # for Linux:
ninja install make -j4 install
# for Windows: # for Windows:
cmake --build . --config {Release|Debug|MinSizeRel|RelWithDebInfo} \ cmake --build . --config {Release|Debug|MinSizeRel|RelWithDebInfo} \
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment