Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.5 KB

BUILDING.md

File metadata and controls

53 lines (41 loc) · 1.5 KB
Raw

Developer Setup

These steps are required for building and running mirror code from source.

  1. Install Rust, https://rustup.rs
  2. (Linux/Ubuntu/Debian) Install Development Libraries,
    • build-essential
    • pkg-config
    • libssl-dev
    • libxcb-composite0-dev
    • cmake
    • fontconfig
    • libfontconfig-dev
    • libxkbcommon-dev
    • libwayland-dev
    • vulkan-tools
    • nvidia-driver-525

One liner,

sudo apt-get install -y build-essential pkg-config libssl-dev libxcb-composite0-dev cmake fontconfig libfontconfig-dev libxkbcommon-dev libwayland-dev vulkan-tools nvidia-driver-525

Also, in order for the UI dev tools to render performantly, drivers need to be updated, run the following

sudo add-apt-repository ppa:oibaf/graphics-drivers -y
sudo apt-get update
sudo apt-get upgrade

This will update the drivers. On Windows, all of this this just works.

  1. Run cargo update (You'll want to do this every once in a while to update deps)
  2. Run cargo build

Steps for setting up VSCode

  1. Install Rust extension,
rust-analyzer
Id: rust-lang.rust-analyzer
Description: Rust language support for Visual Studio Code
Version: 0.3.1369
Publisher: The Rust Programming Language 
VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer

Troubleshooting Common Issues

  1. After running cargo update vscode can't find symbols
  • This happens when updating dependencies. First run cargo clean and then reload vscode.