freya/_docs/
development_setup.rs

1//! # Setup
2//!
3//! Make sure you have [Rust](https://www.rust-lang.org/) and your OS dependencies installed.
4//!
5//! ### Windows
6//!
7//! Install Visual Studio 2022 with the `Desktop Development with C++` workflow.
8//! You can learn learn more [here](https://learn.microsoft.com/en-us/windows/dev-environment/rust/setup#install-visual-studio-recommended-or-the-microsoft-c-build-tools).
9//!
10//! ### Linux
11//!
12//! #### Debian-based (Ubuntu, PopOS, etc)
13//!
14//! Install these packages:
15//! ```sh
16//! sudo apt install build-essential libssl-dev pkg-config cmake libgtk-3-dev libclang-dev
17//! ```
18//!
19//! #### Arch Linux
20//!
21//! Install these packages:
22//! ```sh
23//! sudo pacman -S base-devel openssl cmake gtk3 clang
24//! ```
25//!
26//! #### Fedora
27//!
28//! Install these packages:
29//!
30//! ```sh
31//! sudo dnf install openssl-devel clang-devel systemd-devel gtk3-devel @development-tools -y
32//! ```
33//!
34//! #### NixOS
35//!
36//! Copy this [flake.nix](https://github.com/kuba375/freya-flake) into your project root. Then you can enter a dev shell by `nix develop`.
37//!
38//! Don't hesitate to contribute so other distros can be added here.
39//!
40//! ### MacOS
41//!
42//! No setup required. But feel free to add more if we miss something.
43//!
44//! ## Custom Linkers
45//!
46//! The following custom linkers are not supported at the moment:
47//!
48//! - `mold`
49//!
50//! If there is another one not supported don't hesitate to add it here.