🧪Building from Source
Dev environment
Visual Studio Code with rust-analyzer extension.
For working with QML I recommend to use Qt Creator and load all QML files there, as it has auto-complete and syntax highlighting. The project also supports UI live reload, it's a super quick way of working with the UI. Just change live_reload = true in gyroflow.rs and it should work right away. Now every time you change any QML file, the app should reload it immediately.
Building steps
Prerequisites:
git,7zand workingpowershell. If you never ran powershell scripts before, runset-executionpolicy remotesignedin powershell as adminGet latest stable Rust language from: https://rustup.rs/
Please make sure to check the English language pack option when installing the C++ build tools from Visual Studio Installer
Install
Justby runningcargo install --force justClone the repo:
git clone https://github.com/gyroflow/gyroflow.gitEnter the project directory and:
Install dependencies:
just install-depsCompile and run:
just run
Prerequisites:
git,brewGet latest stable Rust language from: https://rustup.rs/
Install
Justby runningcargo install --force justClone the repo:
git clone https://github.com/gyroflow/gyroflow.gitEnter the project directory and:
Install dependencies:
just install-depsCompile and run:
just runThe first time you run it won't work, run
just deployonce and thenjust runwill work
Prerequisites:
git,7z,python,aptpackage manager (or adjust commands inside scripts if on different distro)Get latest stable Rust language from: https://rustup.rs/
Install
Justby runningcargo install --force justClone the repo:
git clone https://github.com/gyroflow/gyroflow.gitEnter the project directory and:
Install dependencies:
just install-depsCompile and run:
just run
Prerequisites:
git,7z, workingpowershell, Android SDK and NDK. Building is supported only on WindowsGet latest stable Rust language from: https://rustup.rs/
Install
Justby runningcargo install --force justClone the repo:
git clone https://github.com/gyroflow/gyroflow.gitInstall Android SDK and NDK r23c and update paths in
_scripts/android.justEnter the project directory and:
Install dependencies:
just android install-depsCompile the apk and install on device:
just android deploy
Prerequisites:
git,brewGet latest stable Rust language from: https://rustup.rs/
Install
Justby runningcargo install --force justClone the repo:
git clone https://github.com/gyroflow/gyroflow.gitEnter the project directory and:
Install dependencies:
just ios install-depsUpdate Team ID, signing keys and provisioning profiles in
_scripts/ios.justCompile and run on device:
just ios run
Profiling
Install and run
Visual Studio Community EditionCompile and run Gyroflow with the
profileprofile:cargo run --profile profileIn Visual Studio, go to
Debug -> Performance Profiler...Under
Target, openChange Targetand selectRunning Process..., select the runninggyroflow.exeprocess
Uncomment
config.define("QT_QML_DEBUG", None);inbuild.rsComment
cli::run()ingyroflow.rsRun in debug mode with QML debugger args:
cargo run -- "-qmljsdebugger=port:1234,block,services:CanvasFrameRate,EngineControl,DebugMessages"In Qt Creator go to
Analyze->QML Profiler (Attach to Waiting Application)and enter port 1234
Last updated