brush
3D Reconstruction for all
Learn to package the Brush project for deployment across desktop, web, and Android. Discover build commands for each platform and get your application ready.
Main Directories Within the src Folder of Brush: Complete Workspace GuideExplore the src directories in the Brush Rust workspace. Understand how each crate and app in crates/ and apps/ manages its own independent source code structure for efficient development.
How to Automate Tasks in the Brush Project: Complete Script GuideAutomate tasks in the Brush project with npm scripts and Python utilities. Streamline building, development servers, and benchmarks. Learn more.
How to Set Up a Continuous Integration Pipeline for BrushLearn how to set up a continuous integration pipeline for Brush using GitHub Actions. Automate formatting, linting, dependency audits, and tests on every push and pull request.
Purpose of the Docs Folder in the Brush Repository: Current State and Documentation StrategyDiscover why the brush repository lacks a docs folder. Learn how this project distributes documentation effectively through README, CHANGELOG, and inline comments.
How Dependencies Are Managed in the Brush Project: Cargo, npm, and GradleDiscover how the brush project manages dependencies using Cargo for Rust, npm for JavaScript, and Gradle for Android. Optimize your polyglot development workflow effectively.
Does the Brush Project Provide a Documentation Website or API Reference?Discover how the Brush project handles documentation. Learn it uses READMEs and local cargo doc for API references instead of a dedicated website.
Brush Codebase Workflow: A Step-by-Step Guide to ContributingLearn the brush codebase workflow. Set up Rust, make changes, test with cargo, and submit PRs after passing linting. Contribute effectively to the Brush project.
How to Debug the Brush Application: Complete Guide for 3D Gaussian SplattingDebug the brush application efficiently. Use RUST_LOG for verbose logs, cargo run for debug builds, or cargo run release for performance tests. Monitor logs in the UI.
What Coding Standards and Style Guide Does the Brush Renderer Follow?Discover the Rust coding standards and style guide for Brush. Learn how rustfmt formatting, Clippy linting, and CI checks ensure code quality and consistency.
How to Install the Brush Project Locally: Complete Setup GuideInstall the Brush project locally with this complete setup guide. Learn to clone the ArthurBrussee/brush repository and build for desktop, web, or mobile using Rust. Get started now!
Licensing Information for the Brush Project: Apache 2.0 Terms and ComplianceUnderstand the Brush project's Apache 2.0 license. Learn about its terms for commercial use, modification, and distribution. Ensure compliance with open-source requirements.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →