Skip to content

Commit bf5ec98

Browse files
committed
📝 Add development dependencies and tips
1 parent a4d3f09 commit bf5ec98

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Leverage local LLM via Vim to boost bug breading within your code
1414

1515
- [:arrow_up: Top of Document][heading__top]
1616
- [:building_construction: Requirements][heading__requirements]
17+
- [Development dependencies][heading__development_dependencies]
1718
- [:zap: Quick Start][heading__quick_start]
1819
- [List available user paths for SystemD services][heading__list_available_user_paths_for_systemd_services]
1920
- [Install with Vim package manager of choice][heading__install_with_vim_package_manager_of_choice]
@@ -64,6 +65,36 @@ as [Python](https://www.python.org/) run-time to facilitate
6465
`scripts/proompter-channel-proxy.py` service.
6566

6667

68+
---
69+
70+
71+
### Development dependencies
72+
[heading__development_dependencies]: #development-dependencies
73+
74+
75+
- [Vim Doc](https://github.com/vim-utilities/vimdoc) for help from doc-comments
76+
```bash
77+
git clone https://github.com/vim-utilities/vimdoc
78+
pushd vimdoc
79+
python setup.py config
80+
python setup.py build
81+
pipx install .
82+
popd
83+
```
84+
> Execute with `vimdoc .`
85+
>
86+
> Note; until certain bugs are fixed upstream it is necessary to use the
87+
> patched version of `vimdoc` which handles longer lines, and Vim 8
88+
> parameters a _bit_ more correctly.
89+
- [Vader](https://github.com/junegunn/vader.vim) for testing code
90+
```vim
91+
call plug#begin('~/.vim/plugged')
92+
Plug 'junegunn/vader.vim'
93+
call plug#end()
94+
```
95+
> Execute with `scripts/vader-run-tests.sh --cicd --test units`
96+
97+
6798
______
6899

69100

0 commit comments

Comments
 (0)