Skip to content

Commit

Permalink
doc: document developer workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
davvid committed Feb 18, 2024
1 parent b30bc5a commit 2d48dd7
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,20 @@ used by this plugin. The key name corresponds to the name of the command.
The [Garden file](garden.yaml) can be used to run lint checks using
[Garden](https://gitlab.com/garden-rs/garden).

```sh
```bash
# Run lint checks using "luacheck"
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/telescope-git-selector.nvim)
is a mirror of the main
[repository on gitlab](https://gitlab.com/davvid/telescope-git-selector.nvim)
Expand Down

0 comments on commit 2d48dd7

Please sign in to comment.