diff options
| author | Ashkan Kiani <ashkan.k.kiani@gmail.com> | 2019-11-17 09:58:52 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-17 09:58:52 -0800 |
| commit | ac3df47ffd418b0f3aec49612d9862364820ed8d (patch) | |
| tree | bc3e3a0a688b6a36b7ccd462395db7c86e8af2ea /CONTRIBUTING.md | |
| parent | [docgen] Update README.md (diff) | |
| download | nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.tar nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.tar.gz nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.tar.bz2 nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.tar.lz nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.tar.xz nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.tar.zst nvim-lspconfig-ac3df47ffd418b0f3aec49612d9862364820ed8d.zip | |
Use a template for README.md (#28)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1495e8af..e1d370c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,13 +16,12 @@ from `nvim` to run. It **must** be run from the .git/project root. This could be modified to try to find the .git root with one of our `util.*` functions potentially. -You can run -`nvim -u NONE +'set rtp+=$PWD' +"luafile scripts/docgen.lua" +q` -from the project root. This ensures that it doesn't pick up another -copy of `nvim_lsp` on your system. +You can run `scripts/docgen.sh` from the project root. This ensures that it +doesn't pick up another copy of `nvim_lsp` on your system. -This generates a suffix for README.md +This generates README.md +**DO NOT MODIFY `README.md` DIRECTLY** # skeleton |