diff --git a/.gitattributes b/.gitattributes index 8ada963..e9a902b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,2 @@ *.db filter=lfs diff=lfs merge=lfs -text +*.png filter=lfs diff=lfs merge=lfs -text diff --git a/README.md b/README.md index 9fb862b..968ae4f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,47 @@ -# `zk` – a plain text note-taking assistant +
+

zk

+

A plain text note-taking assistant

+Screenshot +
-Looking for a quick usage example? [Let's get started](http://mickael-menu.github.io/zk/getting-started). +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). It is primarily focused on: -* [keeping your notebook future-proof](http://mickael-menu.github.io/zk/future-proof), by relying on plain text -* [creating notes from templates](http://mickael-menu.github.io/zk/note-creation) -* performing [advanced search queries](http://mickael-menu.github.io/zk/note-filtering) -* being a hub for everything related to your notes, thanks to [command aliases](http://mickael-menu.github.io/zk/config-alias) and [automation](http://mickael-menu.github.io/zk/automation). -* [notebook housekeeping](http://mickael-menu.github.io/zk/notebook-housekeeping) +* [keeping your notebook future-proof](docs/future-proof.md), by relying on plain text +* [creating notes from templates](docs/note-creation.md) +* performing [advanced search queries](docs/note-filtering.md) +* being a hub for everything related to your notes, thanks to [command aliases](docs/config-alias.md) and [automation](docs/automation.md). +* [notebook housekeeping](docs/notebook-housekeeping.md) What `zk` is not: * a note editor -* a tool to serve your notes on the web – for this, you may be interested in [Neuron](http://mickael-menu.github.io/zk/neuron) or [Gollum](https://github.com/gollum/gollum). +* a tool to serve your notes on the web – for this, you may be interested in [Neuron](docs/neuron.md) or [Gollum](https://github.com/gollum/gollum). + +## Roadmap + +* [ ] Tags +* [ ] Link relations +* [ ] Extended YAML front matter support + +## Install + +`zk` was only tested on macOS and Linux. + +### Build from scratch + +Make sure you have a working [Go installation](https://golang.org/), with Go's `bin` directory in your `PATH`. + +```sh +$ git clone https://github.com/mickael-menu/zk.git +$ cd zk +$ chmod a+x go +$ ./go install +$ zk -h +``` diff --git a/docs/assets/media/zk.png b/docs/assets/media/zk.png new file mode 100644 index 0000000..5f089dc --- /dev/null +++ b/docs/assets/media/zk.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa67bba80d7b03b07ad48c6a8ad50728520b1a1bb4a29dfcb998bec6cdf1a2cf +size 381754