Create DEPENDENCIES.md

1 files changed, 33 insertions, 0 deletions

diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md
new file mode 100644
index 00000000..809371cb
--- /dev/null
+++ b/DEPENDENCIES.md
@@ -0,0 +1,33 @@
+# 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;
+}
+```