Add Nix instructions to README
This commit is contained in:
parent
640e13943c
commit
039debd251
1 changed files with 34 additions and 0 deletions
34
README.md
34
README.md
|
|
@ -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`:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue