From 205cf086ddb73cfe68bd6bc9c4b8ac3a6dc8478f Mon Sep 17 00:00:00 2001 From: David Aguilar Date: Mon, 19 Feb 2024 16:26:03 -0800 Subject: [PATCH] README: document developer workflows --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 462becc..e834e61 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,18 @@ The [Garden file](garden.yaml) can be used to run lint checks using ```sh # Run lint checks using "luacheck" -garden lint +garden check ``` +The documentation is generated using [panvimdoc](https://github.com/kdheepak/panvimdoc.git). + +```bash +garden setup # one-time setup +garden doc +``` + +Use `garden fmt` to apply code formatting using [stylua](https://github.com/JohnnyMorganz/StyLua). + The [github repository](https://github.com/davvid/harpoon-term.nvim) is a mirror of the main [repository on gitlab](https://gitlab.com/davvid/harpoon-term.nvim)