about summary refs log tree commit diff stats
path: root/pkgs/by-name/vi/vim-plugins/README.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-05-24 14:06:50 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-05-24 14:06:50 +0200
commitf07dd1dde090c231aa3cb4539d0c8695b93ee653 (patch)
treef7908fca18b0ee72d224507ea45d9c454653c274 /pkgs/by-name/vi/vim-plugins/README.md
parentfeat(pkgs): Pull yambar-{cpu,memory} in tree (diff)
downloadnixos-config-f07dd1dde090c231aa3cb4539d0c8695b93ee653.tar.gz
nixos-config-f07dd1dde090c231aa3cb4539d0c8695b93ee653.zip
refactor(pkgs/by-name/vi/vim-plugins): Give nixpkgs compatible name
Nixpkgs already provides `vimPlugins` so having a `vim-plugins` set is
rather confusing. Calling it `vimExtraPlugins` resolves this confusion.
Diffstat (limited to 'pkgs/by-name/vi/vim-plugins/README.md')
-rw-r--r--pkgs/by-name/vi/vim-plugins/README.md92
1 files changed, 0 insertions, 92 deletions
diff --git a/pkgs/by-name/vi/vim-plugins/README.md b/pkgs/by-name/vi/vim-plugins/README.md
deleted file mode 100644
index e8169951..00000000
--- a/pkgs/by-name/vi/vim-plugins/README.md
+++ /dev/null
@@ -1,92 +0,0 @@
-# Fork
-
-All files in this repository where forked form [here](https://github.com/NixNeovim/NixNeovimPlugins) on commit `5010b91eb03696574c3c293f072a090618227e87`.
-Below the original README. They were licensed under the MIT license.
-
-# All vim plugins, ready to go
-
-This repo auto generates nix packages for vim/neovim plugins.
-Packages are automatically updated twice per week using a GitHub Actions.
-Plugins are fetched from the `manifest.txt` and [awesome-neovim][0] repo.
-
-This is a fork of [this repo](https://github.com/m15a/nixpkgs-vim-extra-plugins); however, we fetch all additions from the original repo, so we will never have less plugins.
-Further, the original deletes plugins that are available in the nixpkgs. We, instead, try to assemble a list of all available plugins.
-Therefore, to access plugins you will never have to search in two places.
-
-This repo can be used as a stand-alone, by adding it to your inputs.
-However, we recommend to use [NixNeovim](https://github.com/NixNeovim/NixNeovim) modules instead, and use this only when you need a plugins, which does not have a module, yet.
-
-## Available plugins
-
-The [plugins.md](plugins.md) contains an auto-generated list of all available plugins.
-
-## Usage
-
-- We recommend using [NixNeovim](https://github.com/NixNeovim/NixNeovim), and only access the plugins directly when they do not have a module in NixNeovim.
-
-However, you can also use this repo without NixNeovim:
-To access the plugins, you need to add the overlay.
-The overlay adds extra Vim plugins to `pkgs.vimExtraPlugins`.
-First, add this repo to your inputs:
-
-```
-inputs.nixneovimplugins.url = github:jooooscha/nixpkgs-vim-extra-plugins
-```
-
-Next, apply the provided overlay:
-
-```
-nixpkgs.overlays = [
-  inputs.nixneovimplugins.overlays.default
-];
-```
-
-Finally, you can add the packages to your vim/neovim config. For example you can use [NixNeovim](https://github.com/NixNeovim/Nixneovim) or you can add the plugins directly:
-
-```
- programs.neovim = {
-   plugins = [
-     pkgs.vimExtraPlugins.nvim-colorizer-lua
-   ];
- }
-```
-
-More info on using neovim with nix can be found here: [NixOS Neovim](https://nixos.wiki/wiki/Neovim)
-
-## Contribution
-
-### How to add a new plugin
-
-#### 1. Add the plugin to manifest.txt:
-
-```
-# Examples
-
-haringsrob/nvim_context_vt
-sourcehut:henriquehbr/ataraxis.lua
-gitlab:yorickpeterse/nvim-pqf
-williamboman/mason.nvim:45b9a4da776d9fb017960b3ac7241161fb7bc578
-foo/bar::baz                   --> renamed to baz
-foo/bar:dev                    --> using dev branch
-```
-
-Supported are Github (default), SourceHut, and GitLab.
-
-#### 2. Create a Pull Request
-
-- Create a pull request with the changed manifest.txt (and blacklist.txt if neccessary).
-- A GitHub action will check your contribution and generate all neccessary nix code for your new plugin. It will also take care of sorting and cleaning the manifest.txt
-- After all checks have passed, I will merge your change.
-
-I am happy for any contribution. :)
-
-### How to remove a new plugin
-
-Copy the entry from manifest.txt to blacklist.txt and create a PR.
-The GitHub Actions will do the rest, including removing the entry from manifest.txt
-
-## Credits
-
-This is originally based on work by [m15a](https://github.com/m15a/nixpkgs-vim-extra-plugins)
-
-[0]: https://github.com/rockerBOO/awesome-neovim