diff --git a/.rive_head b/.rive_head index 2ab2502a..d951bd1d 100644 --- a/.rive_head +++ b/.rive_head @@ -1 +1 @@ -bcf6451f442d7d55ed423982b58204e93c1d8791 +e68c7b6ded17c667fe344426e54710875fc58e94 diff --git a/README.md b/README.md index 783124a9..2ef3d1a3 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The C++ runtime for Rive provides these runtime features: - Abstract Renderer for submitting high level vector path commands with retained path objects to optimize and minimize path re-computation (ultimately up to the concrete rendering implementation). - Example concrete renderer written in C++ with [Skia](https://skia.org/). Skia renderer code is in [skia/renderer/src/skia_factory.cpp](skia/renderer/src/skia_factory.cpp). -## Build System +## Build system 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 wish to support! We encourage you to use premake as it's highly extensible and configurable for a variety of platforms. ## Build @@ -52,10 +52,10 @@ The tests live in ```rive/test```. To add new tests, create a new ```xxx_test.cp There's a VSCode command provided to ```run tests``` from the Tasks: Run Task command palette. -## Code Formatting +## Code formatting rive-cpp uses clang-format, you can install it with brew on MacOS: ```brew install clang-format```. -## Memory Checks +## Memory checks Note that if you're on MacOS you'll want to install valgrind, which is somewhat complicated these days. This is the easiest solution (please PR a better one when it becomes available). ``` @@ -65,7 +65,7 @@ brew install --HEAD LouisBrunner/valgrind/valgrind You can now run the all the tests through valgrind by running ```test.sh memory```. -## Disassembly Explorer +## Disassembly explorer If you want to examine the generated assembly code per cpp file, install [Disassembly Explorer](https://marketplace.visualstudio.com/items?itemName=dseight.disasexpl) in VSCode. A ```disassemble``` task is provided to compile and preview the generated assembly. You can reach it via the Tasks: Run Task command palette or you can bind it to a shortcut by editing your VSCode keybindings.json: