Skip to content

Commit 8ca0e2b

Browse files
[readme] Minor updates.
1 parent 8ac0303 commit 8ca0e2b

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

documentation/readme/readme.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
> * [how? (concepts, and inner workings)](#how);
2424
> * [why? (history, and reasons)](#why);
2525
> * [contributions](#contributions); [licensing](#license); [SBOM](#sbom-software-bill-of-materials);
26+
> * [chat on Discord](https://discord.gg/fheZqMer), [discuss on GitHub](https://github.com/volution/z-scratchpad/discussions/categories/discussions), or [email author](mailto:[email protected])
2627
2728

2829

@@ -95,9 +96,13 @@ Please see the [contributions](#contributions) and [licensing](#license) section
9596

9697
## <span id="status">Status</span>
9798

98-
> **WIP** (work in progress)
99+
Currently, `z-scratchpad` is still in a pre-release state,
100+
perhaps somewhere between a beta and a release-candidate.
99101

100-
At the moment `z-scratchpad` is still under heavy development.
102+
There is no promise of backward or forward compatibility,
103+
there is little documentation (besides the examples),
104+
there is no testing harness,
105+
and there is no roadmap.
101106

102107
That being said, I'm using it for all my note taking,
103108
from personal notes, to for-work project specific documents.
@@ -267,11 +272,11 @@ Alternatively, one can place it in one's `$HOME/bin` folder and add that to `$PA
267272
### Releases
268273

269274
The self-contained executable is available from the `z-scratchpad` GitHub repository [releases](https://github.com/volution/z-scratchpad/releases):
270-
* [v0.0.1](https://github.com/volution/z-scratchpad/releases/tag/v0.0.1) -- the first preliminary preview release:
271-
* [v0.0.1 for Linux](https://github.com/volution/z-scratchpad/releases/download/v0.0.1/z-scratchpad--linux--v0.0.1) -- tested on OpenSUSE, and used by me in my everyday work;
272-
* [v0.0.1 for OSX](https://github.com/volution/z-scratchpad/releases/download/v0.0.1/z-scratchpad--darwin--v0.0.1) -- untested;
273-
* [v0.0.1 for FreeBSD](https://github.com/volution/z-scratchpad/releases/download/v0.0.1/z-scratchpad--freebsd--v0.0.1) -- untested;
274-
* [v0.0.1 for OpenBSD](https://github.com/volution/z-scratchpad/releases/download/v0.0.1/z-scratchpad--openbsd--v0.0.1) -- untested;
275+
* [v0.1.1](https://github.com/volution/z-scratchpad/releases/tag/v0.1.1) -- the first preliminary preview release:
276+
* [v0.1.1 for Linux](https://github.com/volution/z-scratchpad/releases/download/v0.1.1/z-scratchpad--linux--v0.1.1) -- tested on OpenSUSE, and used by me in my everyday work;
277+
* [v0.1.1 for OSX](https://github.com/volution/z-scratchpad/releases/download/v0.1.1/z-scratchpad--darwin--v0.1.1) -- untested;
278+
* [v0.1.1 for FreeBSD](https://github.com/volution/z-scratchpad/releases/download/v0.1.1/z-scratchpad--freebsd--v0.1.1) -- untested;
279+
* [v0.1.1 for OpenBSD](https://github.com/volution/z-scratchpad/releases/download/v0.1.1/z-scratchpad--openbsd--v0.1.1) -- untested;
275280

276281
Also, each of these files are signed with my PGP key `5A974037A6FD8839`, thus do check the signature.
277282

@@ -292,10 +297,10 @@ gpg: imported: 1
292297
* download the executable and signature (replace the `linux` token with `darwin` (for OSX), `freebsd` or `openbsd`):
293298
~~~~
294299
curl -s -L -S -f -o ./z-scratchpad \
295-
https://github.com/volution/z-scratchpad/releases/download/v0.0.1/z-scratchpad--linux--v0.0.1
300+
https://github.com/volution/z-scratchpad/releases/download/v0.1.1/z-scratchpad--linux--v0.1.1
296301
297302
curl -s -L -S -f -o ./z-scratchpad.asc \
298-
https://github.com/volution/z-scratchpad/releases/download/v0.0.1/z-scratchpad--linux--v0.0.1.asc
303+
https://github.com/volution/z-scratchpad/releases/download/v0.1.1/z-scratchpad--linux--v0.1.1.asc
299304
~~~~
300305

301306
* verify the executable:
@@ -330,15 +335,17 @@ sudo cp ./z-scratchpad /usr/local/bin/z-scratchpad
330335
z-scratchpad --version
331336
~~~~
332337
~~~~
333-
* version : 0.0.1
334-
* executable : z-scratchpad
335-
* build target : release, linux-amd64, go1.16.7, gc
336-
* build number : 2025, 2021-08-13-11-56-08
338+
* tool : z-scratchpad
339+
* version : 0.1.1
340+
* executable : /usr/local/bin/z-scratchpad
341+
* build target : release, linux-amd64, go1.18.3, gc
342+
* build number : 4543, 2022-07-26-21-00-31
337343
* code & issues : https://github.com/volution/z-scratchpad
338-
* sources git : 1abeee1c76fc4a40e1465e4810be0258992d1815
339-
* sources hash : 51382d0da05c3e129fc73eac59754fad
344+
* sources git : 8ac0303de9f139a550bc7634cc59b7575dfcf2b0
345+
* sources hash : 958636a84ba8b31f7cebdd2e8d368973
340346
* uname node : some-workstation
341-
* uname system : Linux, 5.some-version, x86_64
347+
* uname system : Linux, 5.18.4-1-default, x86_64
348+
* uname hash : 636fe534b72441e2ccb478f9bd56d653
342349
~~~~
343350

344351
### Build from source
@@ -370,15 +377,17 @@ sudo cp ./z-scratchpad /usr/local/bin/z-scratchpad
370377
z-scratchpad --version
371378
~~~~
372379
~~~~
373-
* version : 0.0.1
374-
* executable : z-scratchpad
375-
* build target : release, linux-amd64, go1.16.7, gc
376-
* build number : 2025, 2021-08-13-11-56-08
380+
* tool : z-scratchpad
381+
* version : 0.1.1
382+
* executable : /usr/local/bin/z-scratchpad
383+
* build target : release, linux-amd64, go1.18.3, gc
384+
* build number : 4543, 2022-07-26-21-00-31
377385
* code & issues : https://github.com/volution/z-scratchpad
378-
* sources git : 1abeee1c76fc4a40e1465e4810be0258992d1815
379-
* sources hash : 51382d0da05c3e129fc73eac59754fad
386+
* sources git : 8ac0303de9f139a550bc7634cc59b7575dfcf2b0
387+
* sources hash : 958636a84ba8b31f7cebdd2e8d368973
380388
* uname node : some-workstation
381-
* uname system : Linux, 5.some-version, x86_64
389+
* uname system : Linux, 5.18.4-1-default, x86_64
390+
* uname hash : 636fe534b72441e2ccb478f9bd56d653
382391
~~~~
383392

384393

0 commit comments

Comments
 (0)