summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGokul Swaminathan <[email protected]>2022-11-15 19:47:04 -0800
committerGitHub <[email protected]>2022-11-15 22:47:04 -0500
commitfa6164f8fb067498de8d97cbd41646b8d0e37635 (patch)
tree3e530e2a0f214b34b6349ca871c520a6b604aa05 /README.md
parent546f56f873feb7342396b79b79eed85191f24b1b (diff)
Improve Nix Flake (#48)
* Improve nix flake * Go back to unstable * Update flake * Update README.md
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: