Skip to content

Commit 86fff6a

Browse files
committed
docs: add installation instructions
1 parent 646c3a1 commit 86fff6a

File tree

4 files changed

+40
-5
lines changed

4 files changed

+40
-5
lines changed

.github/workflows/gh-pages.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
- name: Upload GitHub Pages artifact
3030
uses: actions/upload-pages-artifact@v3
3131
with:
32-
path: docs
32+
path: .
3333

3434
deploy:
3535
runs-on: ubuntu-latest

docs/src/SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Summary
22

3-
- [Chapter 1](./chapter_1.md)
3+
- [Installation](./installation.md.md)

docs/src/chapter_1.md

-3
This file was deleted.

docs/src/installation.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Installation
2+
3+
## Homebrew
4+
5+
```sh
6+
brew install nik-rev/tap/ferrishot
7+
```
8+
9+
## PowerShell
10+
11+
```sh
12+
powershell -ExecutionPolicy Bypass -c "irm https://github.com/nik-rev/ferrishot/releases/latest/download/ferrishot-installer.ps1 | iex"
13+
```
14+
15+
## Shell
16+
17+
```sh
18+
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/nik-rev/ferrishot/releases/latest/download/ferrishot-installer.sh | sh
19+
```
20+
21+
## Nix
22+
23+
Add it to your `flake.nix`:
24+
25+
```nix
26+
# add it to your inputs
27+
inputs.ferrishot.url = "github:nik-rev/ferrishot/main";
28+
# then use it in home-manager for example
29+
inputs.ferrishot.packages.${pkgs.system}.default
30+
```
31+
32+
## Cargo
33+
34+
If you use Linux, see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for details on which dependencies you will need.
35+
36+
```sh
37+
cargo install ferrishot
38+
```

0 commit comments

Comments
 (0)