Skip to content

Commit 0d31259

Browse files
readme uupdate
1 parent b57e5f4 commit 0d31259

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,16 @@ Most of the examples in this project are API examples with limited graphical out
3535
## To Build
3636
This project uses [Git LFS](https://git-lfs.github.com/) for assets and CMAKE to build
3737
- From the root of this project update all the submodules with: `git submodule update --init --recursive`
38-
- `cd` into the `build` directory and type: `cmake -G "${GENERATOR_TYPE}"`
38+
- From the root of this project type `cmake -G ${GENERATOR} -DCMAKE_BUILD_TYPE=Debug`
3939

40-
NOTE: The only `${GENERATOR_TYPE}` that has been tested is `Visual Studio 15 2017 Win64` as Clion reads the CMAKE file directly
40+
Where `${GENERATOR}` is the platform (i.e. `"Unix Makefiles"`)
4141

4242
## To Use
4343
- Build and run the individual examples
4444

45-
NOTE: Asset paths are relative and expect your current working directory to be where the binary is (i.e. relative to `/bin/basic_cube/Debug`)
45+
NOTE: Asset paths are relative and expect your current working directory to a directory below the assets folder.
46+
47+
i.e. the `basic_cube` example should be run from `/bin/basic_cube/Debug`
4648

4749
## Project Structure
4850
- `bin`: This is where the final binary applications are put

0 commit comments

Comments
 (0)