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

Compare commits

merge into: squibid:dev
Branches Tags
squibid:master squibid:lazy squibid:dev
...
pull from: squibid:master
Branches Tags
squibid:lazy squibid:master squibid:dev

1 Commits
dev ... master

Author SHA1 Message Date
Squibid
92d8f8b9ee update readme 2024-12-24 14:28:16 -05:00
1 changed files with 11 additions and 26 deletions
Expand all files Collapse all files

37
README.md
View File

@ -1,14 +1,8 @@
# dep # dep
[![License](https://img.shields.io/github/license/chiyadev/dep)](LICENSE)
[![Maintainer](https://img.shields.io/badge/maintainer-luaneko-pink)][4]
[![Issues](https://img.shields.io/github/issues/chiyadev/dep.svg)][8]
[![Contributors](https://img.shields.io/github/contributors/chiyadev/dep.svg)][9]
> This readme is a work in progress. > This readme is a work in progress.
A versatile, declarative and correct [neovim][2] package manager in [Lua][3]. A versatile, declarative and correct [neovim][1] package manager in [Lua][2].
Originally written for personal use by [luaneko][4]. Originally written for personal use by [luaneko][3].
What does that mean? What does that mean?
@ -16,20 +10,16 @@ What does that mean?
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 luaneko's [neovim-configs][10] for an example of how dep can be used in practice. See also squibid's [neovim-configs][5] for an example of how dep can be used in practice.
## Requirements ## Requirements
- [Neovim][1] 0.6+
- [Neovim][2] 0.6+ - [Git][4]
- [Git][5]
## Setup ## Setup
1. Create `lua/bootstrap.lua` in your neovim config directory. 1. Create `lua/bootstrap.lua` in your neovim config directory.
```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
@ -316,13 +306,8 @@ require "dep" {
dep is licensed under the [MIT License](LICENSE). dep is licensed under the [MIT License](LICENSE).
[1]: https://chiya.dev/posts/2021-11-27-why-package-manager [1]: https://neovim.io/
[2]: https://neovim.io/ [2]: https://www.lua.org/
[3]: https://www.lua.org/ [3]: https://github.com/luaneko
[4]: https://github.com/luaneko [4]: https://git-scm.com/
[5]: https://git-scm.com/ [5]: https://git.squi.bid/nvim
[6]: https://github.com/nvim-telescope/telescope.nvim
[7]: https://github.com/tpope/vim-fugitive
[8]: https://GitHub.com/chiyadev/dep/issues
[9]: https://github.com/chiyadev/dep/graphs/contributors
[10]: https://github.com/luaneko/neovim-config