Skip to content

fix(doc): grammar and readability improvements in README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PowerUser64 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(doc): grammar and readability improvements in README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,36 @@
# nvim-plugin-template

Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua
A template repository for neovim plugins. Includes automatic doc generation based on your project's README, integration tests with Busted, and linting via Stylua.

## Usage

1. Click `use this template` button generate a repo on your github.
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`.
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-remove.
1. Click `use this template` button generate a repo under your github account.
2. Clone the newly-created repository, open a terminal, and cd to the plugin directory.
3. Run `python3 rename.py your-plugin-name`. This will:
1. Replace all occurrences of `nvim-plugin-template` with `your-plugin-name`.
2. Promt you for `y` or `n` to remove example code in `init.lua` and `test/plugin_spec.lua`.
- If you are familiar with this repo, just select `y`.
- Otherwise, I suggest you inspect the contents of thses files first.
3. Lastly, `rename.py` will auto-remove itself.

Now you have a clean plugin environment. Enjoy!
Now you have a clean plugin development environment. Enjoy!

## Format

The CI uses `stylua` to format the code; customize the formatting by editing `.stylua.toml`.
The CI uses `stylua` to format the code. Customize the formatting by editing `.stylua.toml`.

## Test

See [Running tests locally](https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally)
See [running tests locally](https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally).

## CI

- Auto generates doc from README.
- Runs the [nvim-busted-action](https://github.com/nvim-neorocks/nvim-busted-action) for test.
- Auto-generates doc from README.
- Runs the [nvim-busted-action](https://github.com/nvim-neorocks/nvim-busted-action) for tests.
- Lints with `stylua`.

## More

To see this template in action, take a look at my other plugins.

## License MIT
## License: MIT