squibid/dep
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update the README with more relevant information

Browse Source
This commit is contained in:
Squibid
2025-04-24 14:40:13 -05:00
parent d217ffa0b6
commit 452414cafb
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -13,14 +13,13 @@ liking.
2. `declarative` - packages are declared using simple Lua tables. 2. `declarative` - packages are declared using simple Lua tables.
3. `correct` - packages are always loaded in a correct and consistent order. 3. `correct` - packages are always loaded in a correct and consistent order.
See also squibid's [neovim-configs][11] for an example of how dep can be used in See also squibid's [neovim-configs][10] for an example of how dep can be used in
practice. practice.
## Requirements ## Requirements
- [Neovim][2] 0.6+ - [Neovim][2] 0.8+
> Needs checking not sure which version this requires - [Git][6] 2.13+
- [Git][6]
## Setup ## Setup
@ -28,11 +27,11 @@ practice.
```lua ```lua
-- ~/.config/nvim/lua/bootstrap.lua: -- ~/.config/nvim/lua/bootstrap.lua:
-- automatically install `chiyadev/dep` on startup -- automatically install `squibid/dep` on startup
local path = vim.fn.stdpath("data") .. "/site/pack/deps/opt/dep" local path = vim.fn.stdpath("data") .. "/site/pack/deps/opt/dep"
if vim.fn.empty(vim.fn.glob(path)) > 0 then if vim.fn.empty(vim.fn.glob(path)) > 0 then
vim.fn.system({ "git", "clone", "--depth=1", "https://github.com/chiyadev/dep", path }) vim.fn.system({ "git", "clone", "--depth=1", "https://git.squi.bid/dep", path })
end end
vim.cmd("packadd dep") vim.cmd("packadd dep")
@ -65,16 +64,16 @@ A package must be declared in the following format.
-- This is the only required field; all other fields are optional. -- This is the only required field; all other fields are optional.
"user/package", "user/package",
-- [function] Code to run after the package is loaded into neovim.
load = function()
require "package".setup(...)
end,
-- [function] Code to run before the package is loaded into neovim. -- [function] Code to run before the package is loaded into neovim.
setup = function() setup = function()
vim.g.package_config = ... vim.g.package_config = ...
end, end,
-- [function] Code to run after the package is loaded into neovim.
load = function()
require "package".setup(...)
end,
-- [function] Code to run after the package is installed or updated. -- [function] Code to run after the package is installed or updated.
config = function() config = function()
os.execute(...) os.execute(...)
@ -421,5 +420,4 @@ dep is licensed under the [MIT License](LICENSE).
[7]: https://github.com/nvim-telescope/telescope.nvim [7]: https://github.com/nvim-telescope/telescope.nvim
[8]: https://github.com/tpope/vim-fugitive [8]: https://github.com/tpope/vim-fugitive
[9]: https://GitHub.com/chiyadev/dep/issues [9]: https://GitHub.com/chiyadev/dep/issues
[10]: https://github.com/chiyadev/dep/graphs/contributors [10]: https://git.squi.bid/nvim
[11]: https://git.squi.bid/nvim