From 647d1104c48ef2738237f351d86b15ffa5105ac6 Mon Sep 17 00:00:00 2001 From: Sridhar Ratnakumar Date: Fri, 10 Jun 2022 11:12:50 -0400 Subject: [PATCH] docs: flakes must be enabled (resolves #300) --- README.md | 2 +- docs/start/install.md | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 81fce0238..e0366c391 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ https://emanote.srid.ca/examples Emanote is written in Haskell. Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code. Follow these steps: -- [Install Nix](https://nixos.org/download.html) & [enable Flakes](https://nixos.wiki/wiki/Flakes) +- [Install Nix](https://nixos.org/download.html) & [enable Flakes](https://nixos.wiki/wiki/Flakes#Installing_flakes) - Run `nix develop -c haskell-language-server` to sanity check your environment (Expect it to download and build a bunch of things the first time) - Open the repository [as single-folder workspace](https://code.visualstudio.com/docs/editor/workspaces#_singlefolder-workspaces) in Visual Studio Code - Install the [workspace recommended](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) extensions diff --git a/docs/start/install.md b/docs/start/install.md index 5939adb7e..4d6a2109a 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -8,9 +8,12 @@ order: 1 Emanote is supported on all popular operating systems through [Nix]. -1. Install [Nix] (for Windows, see [[wsl]] or [the Docker approach](https://github.com/srid/emanote/issues/230)) -2. Optional: Use Nix cache provided [by garnix](https://garnix.io/docs/caching) -3. Run `nix profile install github:srid/emanote` to install Emanote +1. [Install Nix](https://nixos.org/download.html) & [enable Flakes](https://nixos.wiki/wiki/Flakes#Installing_flakes) + 1. For Windows, see [[wsl]] or [the Docker approach](https://github.com/srid/emanote/issues/230) +1. Optional: Use Nix binary cache provided [by garnix](https://garnix.io/docs/caching) +1. Run `nix profile install github:srid/emanote` to install Emanote[^try] + +[^try]: You may also "try before installing" by running `nix run github:srid/emanote`. This still downloads emanote to your nix store, `/nix`, but will not install it to the user profile like `nix profile install` does. To test your Emanote install,