diff options
| author | Guangxiong Lin <[email protected]> | 2023-01-20 23:05:54 +0800 |
|---|---|---|
| committer | Guangxiong Lin <[email protected]> | 2023-01-20 23:24:56 +0800 |
| commit | 3f6aeea8c795b8bff59c1a8b45700d7bc44da4b9 (patch) | |
| tree | 63dbe7f72fd397a55023a014b9a4eff8ded45400 /README.md | |
| download | zk-3f6aeea8c795b8bff59c1a8b45700d7bc44da4b9.tar.gz zk-3f6aeea8c795b8bff59c1a8b45700d7bc44da4b9.tar.bz2 zk-3f6aeea8c795b8bff59c1a8b45700d7bc44da4b9.zip | |
First commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf54bf6 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# zk + +A commandline tool to help organize markdown notes. + +By default, the current working directory is taken as the root directory +of markdown notes. + +Created for personal use. **USE IT AT YOUR OWN RISK.** + +Install: + +``` +make install +``` + +Usage: + +- `zk mv path/to/source path/to/target`: The same as `mv`. However, + backlinks are updated together. + + - **The source and target paths cannot be directories.** |