Skip to content

Commit

Permalink
docs: flakes must be enabled (resolves #300)
Browse files Browse the repository at this point in the history
  • Loading branch information
srid committed Jun 10, 2022
1 parent e0d5cdf commit 6157ef9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 6 additions & 3 deletions docs/start/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down

0 comments on commit 6157ef9

Please sign in to comment.