Update README.md

This commit is contained in:
Jordan Mandel 2024-05-27 21:21:48 -04:00 committed by GitHub
parent 8c95941003
commit 6ceea579b9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 2 deletions

View File

@ -8,8 +8,7 @@ Neovim plugin template; includes automatic documentation generation from README,
2. Clone your plugin repo. Open terminal then cd plugin directory. 2. Clone your plugin repo. Open terminal then cd plugin directory.
3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`. 3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`.
Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
`test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto `test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.
remove.
Now you have a clean plugin environment. Enjoy! Now you have a clean plugin environment. Enjoy!