diff options
author | 2023-05-20 20:23:00 +0300 | |
---|---|---|
committer | 2023-05-20 20:23:00 +0300 | |
commit | 039debd251feef6225961455181db324bcc0c272 (patch) | |
tree | 622456af5aa584a872da450905a6d937c26a00a3 /README.md | |
parent | 640e13943c04754ef74e11db470b6c9470640623 (diff) | |
download | iced-039debd251feef6225961455181db324bcc0c272.tar.gz iced-039debd251feef6225961455181db324bcc0c272.tar.bz2 iced-039debd251feef6225961455181db324bcc0c272.zip |
Add Nix instructions to README
Diffstat (limited to '')
-rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -63,6 +63,40 @@ __Iced is currently experimental software.__ [Take a look at the roadmap], [check out the issues]: https://github.com/iced-rs/iced/issues [feel free to contribute!]: #contributing--feedback +## Dependencies + +Iced requires some system dependencies to work, and not +all operating systems come with them installed. + +You can follow the provided instructions for your system to +get them, if your system isn't here, add it! + +### NixOS + +You can add this `shell.nix` to your project and use it by running `nix-shell`: + +```nix +{ pkgs ? import <nixpkgs> {} }: + +pkgs.mkShell rec { + buildInputs = with pkgs; [ + expat + fontconfig + freetype + freetype.dev + libGL + pkgconfig + xorg.libX11 + xorg.libXcursor + xorg.libXi + xorg.libXrandr + ]; + + LD_LIBRARY_PATH = + builtins.foldl' (a: b: "${a}:${b}/lib") "${pkgs.vulkan-loader}/lib" buildInputs; +} +``` + ## Installation Add `iced` as a dependency in your `Cargo.toml`: |