Skip to content

Commit

Permalink
move install instructions to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
srid committed Dec 5, 2021
1 parent 30d08dc commit 526e81c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 17 deletions.
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,7 @@ Create beautiful websites -- such as personal webpage, blog, wiki, Zettelkasten,

## Installing and using

```bash
# Install (`cachix use srid` for cached binaries)
nix-env -if https://github.com/srid/emanote/archive/refs/heads/master.tar.gz
# Or, from the Git repo: nix-env -if ./default.nix

# Run live server (HOST and PORT are optional)
cd /path/to/notebook
HOST=0.0.0.0 PORT=8001 emanote

# Generate static files (-L defaults to current directory)
mkdir /tmp/output
emanote -L /path/to/notebook gen /tmp/output
```

For other installation methods, see [here](https://note.ema.srid.ca/start/install).
https://note.ema.srid.ca/start/install

### Examples

Expand Down
19 changes: 17 additions & 2 deletions docs/start/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,24 @@ order: 1

## Official method

Follow the [README on GitHub](https://github.com/srid/emanote#emanote) to install Emanote using [Nix](https://nixos.org/download.html). This is the recommended approach.
Emanote is supported on all popular operating systems through [Nix].

For Windows, see [[wsl]].
1. Install [Nix] (for Windows, see [[wsl]])
2. Run `nix-env -if https://github.com/srid/emanote/archive/refs/heads/master.tar.gz` to install Emanote

To test your Emanote install,

```sh
# Run live server (HOST and PORT are optional)
cd /path/to/notebook
HOST=0.0.0.0 PORT=8001 emanote

# Generate static files (-L defaults to current directory)
mkdir /tmp/output
emanote -L /path/to/notebook gen /tmp/output
```

[Nix]: https://nixos.org/download.html

## Non-nix methods

Expand Down

0 comments on commit 526e81c

Please sign in to comment.