summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0223fc39..ab342980 100644
--- a/README.md
+++ b/README.md
@@ -23,9 +23,21 @@ Sway is an incredible window manager, and certainly one of the most well establi
## Installation
-### Compiling from Source
+### Nix
+
+If you have Nix installed, you can run SwayFX with a single command:
+
+```
+nix run github:WillPower3309/swayfx
+```
-This project contains a nix flake for those who have the nix package manager installed. This flake handles installing the below dependencies when `nix develop` is ran inside of the project root. Otherwise, the below dependencies must be installed prior to building and running this project.
+You can also bring up a development shell and follow the build instructions below, without installing all of the dependencies manually:
+
+```
+nix develop
+```
+
+### Compiling from Source
Install dependencies: