Compare commits

..

1 commit

Author SHA1 Message Date
raf
3fe5c3fba5
Merge 41e5633550 into a1bac1d356 2025-01-06 23:16:20 +02:00
3 changed files with 18 additions and 34 deletions

28
.github/README.md vendored
View file

@ -210,16 +210,12 @@ features.
Alongside myself, nvf is developed by those talented folk: Alongside myself, nvf is developed by those talented folk:
- [**@horriblename**](https://github.com/horriblename) - [**@horriblename**](https://github.com/horriblename) - For actively
([Liberapay](https://liberapay.com/horriblename/))- For actively implementing implementing planned features and quality of life updates.
planned features and quality of life updates.
- [**@Diniamo**](https://github.com/Diniamo) - [**@Diniamo**](https://github.com/Diniamo)
([Liberapay](https://en.liberapay.com/diniamo/)) - For actively submitting ([Liberapay](https://en.liberapay.com/diniamo/)) - For actively submitting
pull requests, issues and assistance with maintenance of nvf. pull requests, issues and assistance with maintenance of nvf.
Please do remember to extend your thanks (financially or otherwise) if this
project has been helpful to you.
### Contributors ### Contributors
[mnw]: https://github.com/gerg-l/mnw [mnw]: https://github.com/gerg-l/mnw
@ -249,17 +245,17 @@ This configuration borrows from and is based on a few other configurations,
including: including:
- [@jordanisaacs's](https://github.com/jordanisaacs) - [@jordanisaacs's](https://github.com/jordanisaacs)
[**neovim-flake**](https://github.com/jordanisaacs/neovim-flake) that this [neovim-flake](https://github.com/jordanisaacs/neovim-flake) that this flake
flake is originally based on. is originally based on.
- [@sioodmy's](https://github.com/sioodmy)
[dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design
choices for UI and plugin defaults.
- [@wiltaylor's](https://github.com/wiltaylor) - [@wiltaylor's](https://github.com/wiltaylor)
[neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and [neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and
design ideas. design ideas.
- [@gvolpe's](https://github.com/gvolpe) - [@gvolpe's](https://github.com/gvolpe)
[neovim-flake](https://github.com/gvolpe/neovim-flake) for plugin, design and [neovim-flake](https://github.com/gvolpe/neovim-flake) for plugin, design and
nix concepts. nix concepts.
- [@sioodmy's](https://github.com/sioodmy)
[dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design
choices for UI and plugin defaults.
I am grateful for their previous work and inspiration, and I wholeheartedly I am grateful for their previous work and inspiration, and I wholeheartedly
recommend checking their work out. recommend checking their work out.
@ -267,12 +263,12 @@ recommend checking their work out.
## License ## License
Following the license of Following the license of the
[the original neovim-flake](https://github.com/jordanisaacs/neovim-flake), nvf [original neovim-flake](https://github.com/jordanisaacs/neovim-flake), nvf has
has been made available under the [**MIT License**](LICENSE). However, all been made available under the [**MIT License**](LICENSE). However, all assets
assets and documentation are published under the and documentation are published under the
[**CC BY License**](https://github.com/NotAShelf/nvf/blob/main/.github/assets/LICENSE) [**CC BY License**](https://github.com/NotAShelf/nvf/blob/main/.github/assets/LICENSE)
under explicit permission by the author or authors. under explicit permission by the artist.
<h6 align="center">Yes, this includes the logo work too. Stop taking artwork that is not yours!</h6> <h6 align="center">Yes, this includes the logo work too. Stop taking artwork that is not yours!</h6>

View file

@ -10,18 +10,12 @@ To use it, we first add the input flake.
```nix ```nix
{ {
inputs = { inputs = {
# Optional, if you intend to follow nvf's obsidian-nvim input
# you must also add it as a flake input.
obsidian-nvim.url = "github:epwalsh/obsidian.nvim"; obsidian-nvim.url = "github:epwalsh/obsidian.nvim";
# Required, nvf works best and only directly supports flakes
nvf = { nvf = {
url = "github:notashelf/nvf"; url = "github:notashelf/nvf";
# You can override the input nixpkgs to follow your system's # you can override input nixpkgs
# instance of nixpkgs. This is safe to do as nvf does not depend
# on a binary cache.
inputs.nixpkgs.follows = "nixpkgs"; inputs.nixpkgs.follows = "nixpkgs";
# Optionally, you can also override individual plugins # you can also override individual plugins
# for example: # for example:
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
}; };
@ -33,8 +27,8 @@ Followed by importing the home-manager module somewhere in your configuration.
```nix ```nix
{ {
# Assuming "nvf" is in your inputs and inputs is in the argument set. # assuming nvf is in your inputs and inputs is in the argset
# See example installation below # see example below
imports = [ inputs.nvf.homeManagerModules.default ]; imports = [ inputs.nvf.homeManagerModules.default ];
} }
``` ```

View file

@ -10,18 +10,12 @@ To use it, we first add the input flake.
```nix ```nix
{ {
inputs = { inputs = {
# Optional, if you intend to follow nvf's obsidian-nvim input
# you must also add it as a flake input.
obsidian-nvim.url = "github:epwalsh/obsidian.nvim"; obsidian-nvim.url = "github:epwalsh/obsidian.nvim";
# Required, nvf works best and only directly supports flakes
nvf = { nvf = {
url = "github:notashelf/nvf"; url = "github:notashelf/nvf";
# You can override the input nixpkgs to follow your system's # you can override input nixpkgs
# instance of nixpkgs. This is safe to do as nvf does not depend
# on a binary cache.
inputs.nixpkgs.follows = "nixpkgs"; inputs.nixpkgs.follows = "nixpkgs";
# Optionally, you can also override individual plugins # you can also override individual plugins
# for example: # for example:
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
}; };