Skip to content

Commit

Permalink
feat(docs): add more detailed description
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed Aug 23, 2024
1 parent 3ee1bd2 commit b044c5e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# rtp.nvim

Source plugin and ftdetect directories on the Neovim runtimepath.
Source `plugin` and `ftdetect` directories on the Neovim `:h runtimepath`.

See the [API reference](./doc/rtp_nvim.txt) for details.
If you install plugins to a different location than the `:h packpath`,
you can use this library to source their
`plugin`, `ftdetect` and `after-directory` scripts.

The main use cases are:

- As a dependency for plugin managers,
such as [rocks-dev.nvim](https://github.com/nvim-neorocks/rocks-dev.nvim).
- For use with lazy-loading utilities,
such as [rocks-lazy.nvim](https://github.com/nvim-neorocks/rocks-lazy.nvim)
or [lz.n](https://github.com/nvim-neorocks/lz.n).

See the [API reference](./doc/rtp_nvim.txt) for documentation.
3 changes: 3 additions & 0 deletions doc/rtp_nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

Source |plugin| and |ftdetect| directories on the Neovim runtimepath

If you install plugins to a different location than the |packpath|,
you can use this library to source their
|plugin|, |ftdetect| and |after-directory| scripts.

rtp_nvim.source_rtp_dir({dir}) *rtp_nvim.source_rtp_dir*
Source the `plugin` and `ftdetect` directories.
Expand Down
3 changes: 3 additions & 0 deletions lua/rtp_nvim.lua
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
---
---Source |plugin| and |ftdetect| directories on the Neovim runtimepath
---
---If you install plugins to a different location than the |packpath|,
---you can use this library to source their
---|plugin|, |ftdetect| and |after-directory| scripts.
---@brief ]]

-- Copyright (C) 2024 Neorocks Org.
Expand Down

0 comments on commit b044c5e

Please sign in to comment.