Skip to content

Commit 9bfd48d

Browse files
committed
update site
1 parent 133a49e commit 9bfd48d

File tree

3 files changed

+27
-20
lines changed

3 files changed

+27
-20
lines changed

README.org

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ See the [[https://j-keck.github.io/zfs-snap-diff/][website]] for more details.
2323

2424
The minimum supported go version is =go1.12=.
2525

26-
- clone this repo: ~git clone https://github.com/j-keck/zfs-snap-diff~
26+
- clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
2727
- ~cd zfs-snap-diff~
2828
- build it: ~go build -ldflags="-X main.version=$(git describe)" ./cmd/zfs-snap-diff~
2929

@@ -35,7 +35,7 @@ See the [[https://j-keck.github.io/zfs-snap-diff/][website]] for more details.
3535
I use [[https://nixos.org/nix/][nix]] to build my projects. The ~nix~ build also compiles the frontend
3636
to javascript and decode it in ~pkg/webapp/bindata.go~.
3737

38-
- clone this repo: ~git clone https://github.com/j-keck/zfs-snap-diff~
38+
- clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
3939
- ~cd zfs-snap-diff~
4040
- build it: ~nix-build -A zfs-snap-diff~
4141

doc/site/content/docs/install.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,35 @@ You can download the latest binary package from here or from the [GitHub release
2323

2424
{{<tabs "install">}}
2525
{{< tab "Linux" >}}
26-
Download the beta version for ****Linux amd64**** here:
26+
1.) ****Download**** the latest version for ****Linux amd64****: [zfs-snap-diff-linux-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-linux-v1.0.0.tgz)
2727

28-
[zfs-snap-diff-linux-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-linux-v1.0.0.tgz)
28+
2.) Unpack the archive: `tar xvf zfs-snap-diff-linux-v1.0.0.tgz`
29+
30+
3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
2931
{{< /tab >}}
3032

3133
{{< tab "FreeBSD" >}}
32-
Download the beta version for ****FreeBSD amd64**** here:
34+
1.) ****Download**** the latest version for ****FreeBSD amd64****: [zfs-snap-diff-freebsd-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-freebsd-v1.0.0.tgz)
35+
36+
2.) Unpack the archive: `tar xvf zfs-snap-diff-freebsd-v1.0.0.tgz`
3337

34-
[zfs-snap-diff-freebsd-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-freebsd-v1.0.0.tgz)
38+
3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
3539
{{< /tab >}}
3640

3741
{{< tab "macOS" >}}
38-
Download the beta version for ****macOS amd64**** here:
42+
1.) ****Download**** the latest version for ****macOS amd64****: [zfs-snap-diff-darwin-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-darwin-v1.0.0.tgz)
3943

40-
[zfs-snap-diff-darwin-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-darwin-v1.0.0.tgz)
44+
2.) Unpack the archive: `tar xvf zfs-snap-diff-darwin-v1.0.0.tgz`
45+
46+
3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
4147
{{< /tab >}}
4248

4349
{{< tab "Solaris" >}}
44-
Download the beta version for ****Solaris amd64**** here:
50+
1.) ****Download**** the latest version for ****Solaris amd64****: [zfs-snap-diff-solaris-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-solaris-v1.0.0.tgz)
51+
52+
2.) Unpack the archive: `tar xvf zfs-snap-diff-solaris-v1.0.0.tgz`
4553

46-
[zfs-snap-diff-solaris-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-solaris-v1.0.0.tgz)
54+
3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
4755
{{< /tab >}}
4856

4957
{{< /tabs >}}
@@ -70,7 +78,7 @@ go source file so you need only the go compiler to compile it yourself.
7078

7179
The minimum supported go version is `go1.12`.
7280

73-
- clone this repo: `git clone https://github.com/j-keck/zfs-snap-diff`
81+
- clone this repo: `git clone --depth 1 https://github.com/j-keck/zfs-snap-diff`
7482
- `cd zfs-snap-diff`
7583
- build it: `go build -ldflags="-X main.version=$(git describe)" ./cmd/zfs-snap-diff`
7684

@@ -82,7 +90,7 @@ The optional `-ldflags="-X main.version=$(git describe)"` flag updates the `vers
8290
I use [nix](https://nixos.org/nix/) to build my projects. The `nix` build also compiles the frontend
8391
to javascript and decode it in `pkg/webapp/bindata.go`.
8492

85-
- clone this repo: `git clone -b dev https://github.com/j-keck/zfs-snap-diff`
93+
- clone this repo: `git clone --depth 1 https://github.com/j-keck/zfs-snap-diff`
8694
- change to the checkout directory: `cd zfs-snap-diff`
8795
- build it: `nix-build -A zfs-snap-diff`
8896

site.org

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,12 @@ You can download the latest binary package from here or from the [[https://githu
8282

8383
(defun section-for (platform artifact version)
8484
(format (concat "{{< tab \"%s\" >}}\n"
85-
"Download the beta version for **%s amd64** here:\n\n"
86-
"[[https://github.com/j-keck/zfs-snap-diff/releases/download/%s/%s][%s]]\n"
85+
" 1.) **Download** the latest version for **%s amd64**: "
86+
"[[https://github.com/j-keck/zfs-snap-diff/releases/download/%s/%s][%s]]\n\n"
87+
" 2.) Unpack the archive: ~tar xvf %s~\n\n"
88+
" 3.) Run it: ~./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>~\n"
8789
"{{< /tab >}}\n\n"
88-
) platform platform version artifact artifact))
90+
) platform platform version artifact artifact artifact))
8991

9092
(let ((v (version-string)))
9193
(princ "\n\n{{<tabs \"install\">}}\n")
@@ -96,9 +98,6 @@ You can download the latest binary package from here or from the [[https://githu
9698
(princ "{{< /tabs >}}\n\n"))
9799
#+END_SRC
98100

99-
#+RESULTS:
100-
101-
102101

103102
{{< hint warning >}}
104103
Try with the ~-use-sudo~ flag if it's not working - and please give feedback.
@@ -122,7 +121,7 @@ platform, feel free to contact me!
122121

123122
The minimum supported go version is =go1.12=.
124123

125-
- clone this repo: ~git clone https://github.com/j-keck/zfs-snap-diff~
124+
- clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
126125
- ~cd zfs-snap-diff~
127126
- build it: ~go build -ldflags="-X main.version=$(git describe)" ./cmd/zfs-snap-diff~
128127

@@ -134,7 +133,7 @@ The optional ~-ldflags="-X main.version=$(git describe)"~ flag updates the ~vers
134133
I use [[https://nixos.org/nix/][nix]] to build my projects. The ~nix~ build also compiles the frontend
135134
to javascript and decode it in ~pkg/webapp/bindata.go~.
136135

137-
- clone this repo: ~git clone -b dev https://github.com/j-keck/zfs-snap-diff~
136+
- clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
138137
- change to the checkout directory: ~cd zfs-snap-diff~
139138
- build it: ~nix-build -A zfs-snap-diff~
140139

0 commit comments

Comments
 (0)