mirror of
https://github.com/NotAShelf/neovim-flake.git
synced 2024-12-19 09:49:48 +01:00
docs: update readme
This commit is contained in:
parent
1ac4dd7d98
commit
242f52e248
3 changed files with 16 additions and 11 deletions
25
README.md
25
README.md
|
@ -2,29 +2,34 @@
|
||||||
|
|
||||||
A highly configurable nix flake for neovim.
|
A highly configurable nix flake for neovim.
|
||||||
|
|
||||||
Come join the Matrix room if you have any questions or need help: [#neovim-flake:matrix.org](https://matrix.to/#/#neovim-flake:matrix.org)
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
See the [neovim-flake Manual](https://jordanisaacs.github.io/neovim-flake/) for documentation, available options, and release notes.
|
See the [neovim-flake Manual](https://notashelf.github.io/neovim-flake/) for documentation, available options, and release notes.
|
||||||
|
|
||||||
If you want to dive right into trying neovim-flake you can get a fully featured configuration with `nix` language support by running:
|
If you want to dive right into trying neovim-flake you can get a fully featured configuration with `nix` language support by running:
|
||||||
|
|
||||||
```
|
```console
|
||||||
nix run github:jordanisaacs/neovim-flake
|
nix run github:notashelf/neovim-flake
|
||||||
```
|
```
|
||||||
|
|
||||||
## Screenshot
|
## Help
|
||||||
|
|
||||||
![screenshot](./screenshot.png)
|
You can create an issue on the [issue tracker](issues) to ask questions or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue tracker for now.
|
||||||
|
|
||||||
## Philosophy
|
## Philosophy
|
||||||
|
|
||||||
The philosophy behind this flake configuration is to allow for easily configurable and reproducible neovim environments. Enter a directory and have a ready to go neovim configuration that is the same on every machine. Whether you are a developer, writer, or live coder (see tidal cycles below!), quickly craft a config that suits every project's need. Think of it like a distribution of Neovim that takes advantage of pinning vim plugins and third party dependencies (such as tree-sitter grammars, language servers, and more).
|
The philosophy behind this flake configuration is to create an eaesily configurable and reproducible neovim environment. While it does sacrifice in size (which I know some users
|
||||||
|
will find *disagreeable*), it offers a lot of flexibility and configurability. It is also very easy to add your own plugins and configuration. Whether you are a developer, writer, or live coder (see tidal cycles below!), quickly craft a config that suits every project's need. Think of it like a distribution of Neovim that takes advantage of pinning vim plugins and third party dependencies (such as tree-sitter grammars, language servers, and more).
|
||||||
|
|
||||||
As a result, one should never get a broken config when setting options. If setting multiple options results in a broken neovim, file an issue! Each plugin knows when another plugin which allows for smart configuration of keybindings and automatic setup of things like completion sources and languages.
|
As a result, one should never get a broken config when setting options. If setting multiple options results in a broken neovim, file an issue! Each plugin knows when another plugin which allows for smart configuration of keybindings and automatic setup of things like completion sources and languages.
|
||||||
|
|
||||||
|
|
||||||
## Credit
|
## Credit
|
||||||
|
|
||||||
Originally based on Wil Taylor's amazing [neovim-flake](https://github.com/wiltaylor/neovim-flake)
|
This configuration is based on a few other configurations, including:
|
||||||
|
|
||||||
|
- @sioodmy's [dotfiles](https://github.com/sioodmy/dotfiles)
|
||||||
|
- @wiltaylor's [neovim-flake](https://github.com/wiltaylor/neovim-flake)
|
||||||
|
- @jordanisaacs's [neovim-flake](https://github.com/jordanisaacs/neovim-flake)
|
||||||
|
- @gvolpe's [neovim-flake](https://github.com/gvolpe/neovim-flake)
|
||||||
|
|
||||||
|
I am grateful for their work and inspiration.
|
||||||
|
|
Before Width: | Height: | Size: 204 KiB After Width: | Height: | Size: 204 KiB |
|
@ -166,7 +166,7 @@ in {
|
||||||
}
|
}
|
||||||
${
|
${
|
||||||
if cfg.smoothScroll.enable
|
if cfg.smoothScroll.enable
|
||||||
then "require('cinnamon').setup()"
|
then "require('cinnamon').setup()" 4
|
||||||
else ""
|
else ""
|
||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
|
|
Loading…
Reference in a new issue