Added support for local install of premake5 using PATH environment variable
diff --git a/README.md b/README.md index 4c75389..12fa22a 100644 --- a/README.md +++ b/README.md
@@ -15,7 +15,9 @@ We use [premake5](https://premake.github.io/). The Rive dev team primarily works on MacOS. There is some work done by the community to also support Windows and Linux. PRs welcomed for specific platforms you with to support! We encourage you to use premake as it's highly extensible and configurable for a variety of platforms. ## Build -In the ```rive``` directory, run ```build.sh``` to debug build and ```build.sh release``` for a release build. +In the ```rive-cpp``` directory, run ```build.sh``` to debug build and ```build.sh release``` for a release build. + +If you've put the `premake5` executable in the `rive-cpp/build` folder, you can run it with `PATH=.:$PATH ./build.sh` ## Testing Uses the [Catch2](https://github.com/catchorg/Catch2) testing framework. @@ -27,6 +29,8 @@ In the ```dev``` directory, run ```test.sh``` to compile and execute the tests. +(if you've installed `premake5` in `rive-cpp/build`, you can run it with `PATH=../../build:$PATH ./test.sh`) + The tests live in ```rive/test```. To add new tests, create a new ```xxx_test.cpp``` file here. The test harness will automatically pick up the new file. There's a VSCode command provided to ```run tests``` from the Tasks: Run Task command palette.