Skip to content

Commit

Permalink
Add a screencast to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mickael-menu committed Feb 28, 2021
1 parent 6175a73 commit 838f316
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 4 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<div align="center">
<h1>zk</h1>
<h4>A plain text note-taking assistant</h4>
<img alt="Screenshot" width="80%" src="docs/assets/media/zk.png"/>
<img alt="Screencast" width="85%" src="docs/assets/media/screencast.svg"/>
<p>Looking for a quick usage example? <a href="docs/getting-started.md">Let's get started</a>.</p>
</div>

Looking for a quick usage example? [Let's get started](docs/getting-started.md).

## Description

`zk` is a command-line tool helping you to maintain a plain text [Zettelkasten](https://zettelkasten.de/introduction/) or [personal wiki](https://en.wikipedia.org/wiki/Personal_wiki).
Expand Down
1 change: 1 addition & 0 deletions docs/assets/media/screencast.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/assets/media/screencast_shadow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion go
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
VERSION=`git describe --tags 2> /dev/null`
BUILD=`git rev-parse --short HEAD`

go $1 -tags "fts5 icu" -ldflags "-X=main.Version=$VERSION -X=main.Build=$BUILD" ${@:2}
CGO_ENABLED=1 go $1 -tags "fts5 icu" -ldflags "-X=main.Version=$VERSION -X=main.Build=$BUILD" ${@:2}

0 comments on commit 838f316

Please sign in to comment.