| commit | 583c10571c451b55481a1bfb54420b9a7c73d34d | [log] [tgz] |
|---|---|---|
| author | rivessamr <hello@rive.app> | Fri Aug 23 21:55:37 2024 +0000 |
| committer | rivessamr <hello@rive.app> | Fri Aug 23 21:55:37 2024 +0000 |
| tree | 5a8c10589d199ad7c291cf4d887e8dc97ff70dd0 | |
| parent | b2160fb51ec2bd59ecb96d083c6f31551f225c34 [diff] |
Pushing merge, resolved using upstream.\n\n message=Fix actions yaml with rive-renderer Fix actions yaml with rive-renderer instead of cpp Diffs= 21ecf2775 Fix actions yaml with rive-renderer (#7930) c33d5d81b Update rive renderer readme (#7929) b03895fcf Update pls README (#7927) 3316d15ca Refactor pls into runtime (#7914) Co-authored-by: Chris Dalton <99840794+csmartdalton@users.noreply.github.com> Co-authored-by: rivessamr <suki@rive.app> diff=\n\ndiff --cc pls/README.md index 1f4232bd,272c7360..00000000 --- a/pls/README.md +++ b/pls/README.md @@@ -2,21 -2,21 +2,37 @@@ The Rive Renderer is a vector and raster graphics renderer custom-built for Rive content, for animation, and for runtime. ++<<<<<<< ours +This repository contains the renderer code and an example for how to interface with it directly. The code within this repository does not contain a Rive runtime. It contains the best in class concrete implementation of Rive's rendering abstraction layer, which we call the Rive Renderer. + +## Clone this repo + +Make sure to clone this repo with submodules! + +``` +git clone --recurse-submodules git@github.com:rive-app/rive-renderer.git ++======= + This folder contains the renderer code and an example for how to interface with it directly. It contains the best in class concrete implementation of Rive's rendering abstraction layer, which we call the Rive Renderer. + + ## Clone the rive-runtime repo + + ``` + git clone https://github.com/rive-app/rive-runtime.git + cd rive-runtime/pls ++>>>>>>> theirs ``` ## Build GLFW ``` ++<<<<<<< ours +cd submodules/rive-cpp/skia/dependencies +./make_glfw.sh ++======= + pushd ../skia/dependencies + ./make_glfw.sh + popd ++>>>>>>> theirs ``` ## Install Python PLY @@@ -28,7 -28,7 +44,11 @@@ python3 -m pip install pl ## Add build_rive.sh to $PATH ``` ++<<<<<<< ours +export PATH="$PATH:$(pwd)/submodules/rive-cpp/build" ++======= + export PATH="$PATH:$(realpath ../build)" ++>>>>>>> theirs ``` ## Build & run
Rive C++ is a runtime library for Rive, a real-time interactive design and animation tool.
The C++ runtime for Rive provides these runtime features:
We use premake5. 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.
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
Rive makes use of clang vector builtins, which are, as of 2022, still a work in progress. Please use clang and ensure you have the latest version.
cd skia/dependencies ./make_skia.sh // this will invoke get_skia.sh
To build viewer (plus you'll needed CMake installed)
./make_viewer_dependencies.sh
Uses the Catch2 testing framework.
cd dev ./test.sh
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.
rive-cpp uses clang-format, you can install it with brew on MacOS: brew install clang-format.
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).
brew tap LouisBrunner/valgrind brew install --HEAD LouisBrunner/valgrind/valgrind
You can now run the all the tests through valgrind by running test.sh memory.
If you want to examine the generated assembly code per cpp file, install Disassembly Explorer 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:
[
{
"key": "cmd+d",
"command": "workbench.action.tasks.runTask",
"args": "disassemble"
}
]