Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Nix instructions to README #1859

Merged
merged 3 commits into from
May 29, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add Nix instructions to README
RGBCube authored May 20, 2023

Verified

This commit was signed with the committer’s verified signature.
kianenigma Kian Paimani
commit 039debd251feef6225961455181db324bcc0c272
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`: