mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-11-22 21:30:51 +00:00
docs: update assets path in the README
This commit is contained in:
parent
b96737b3a7
commit
f2c90a861d
2 changed files with 82 additions and 46 deletions
128
.github/README.md
vendored
128
.github/README.md
vendored
|
@ -1,5 +1,5 @@
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="../assets/neovim-flake-logo-work.svg" alt="neovim-flake Logo" width="200">
|
<img src=".github/assets/neovim-flake-logo-work.svg" alt="neovim-flake Logo" width="200">
|
||||||
</div>
|
</div>
|
||||||
<h1 align="center">❄️ neovim-flake</h1>
|
<h1 align="center">❄️ neovim-flake</h1>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
@ -30,7 +30,10 @@
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a>
|
<a>
|
||||||
A highly modular, configurable, extensible and easy to use Neovim configuration wrapper written in Nix. Designed for flexibility and ease of use, this flake allows you to easily configure your Neovim instance with a few lines of Nix code.
|
A highly modular, configurable, extensible and easy to use Neovim configuration
|
||||||
|
wrapper written in Nix. Designed for flexibility and ease of use, this flake
|
||||||
|
allows you to easily configure your Neovim instance with a few lines of
|
||||||
|
Nix code.
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -62,106 +65,137 @@
|
||||||
|
|
||||||
### Using `nix` CLI
|
### Using `nix` CLI
|
||||||
|
|
||||||
If you would like to try out the configuration before even thinking about installing it, you can run the following command
|
If you would like to try out the configuration before even thinking about
|
||||||
|
installing it, you can run the following command
|
||||||
|
|
||||||
```console
|
```console
|
||||||
nix run github:notashelf/neovim-flake
|
nix run github:notashelf/neovim-flake
|
||||||
```
|
```
|
||||||
|
|
||||||
This will get you a feel for the base configuration and UI design. The flake exposes `#nix` as the default package, providing minimal language support and various
|
This will get you a feel for the base configuration and UI design.
|
||||||
utilities.You may also use `#nix`, `#tidal` or `#maximal` to get try out different configurations.
|
The flake exposes `#nix` as the default package, providing minimal
|
||||||
|
language support and various utilities.You may also use `#nix`,
|
||||||
|
`#tidal` or `#maximal` to get try out different configurations.
|
||||||
|
|
||||||
It is as simple as changing the target output to get a different configuration. For example, to get a configuration with `tidal` support, run:
|
It is as simple as changing the target output to get a different
|
||||||
|
configuration. For example, to get a configuration with `tidal` support, run:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
nix run github:notashelf/neovim-flake#tidal
|
nix run github:notashelf/neovim-flake#tidal
|
||||||
```
|
```
|
||||||
|
|
||||||
Similar instructions will apply for `nix profile install`. However, you are recommended to instead use the module system as described in the manual.
|
Similar instructions will apply for `nix profile install`. However, you are
|
||||||
|
recommended to instead use the module system as described in the manual.
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> The `maximal` configuration is _massive_ and will take a while to build. To get a feel for the configuration, use the default `nix` or `tidal` configurations.
|
> The `maximal` configuration is _massive_ and will take a while to build.
|
||||||
> Should you choose to try out the `maximal` configuration, using the binary cache as described in the manual is _strongly_ recommended.
|
> To get a feel for the configuration, use the default `nix` or `tidal`
|
||||||
|
> configurations. Should you choose to try out the `maximal` configuration,
|
||||||
|
> using the binary cache as described in the manual is _strongly_ recommended.
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
As of version 0.5, an image for the `nix` output is published to Dockerhub and GitHub packages with each tagged release. If you do not have Nix installed
|
As of version 0.5, an image for the `nix` output is published to Dockerhub
|
||||||
|
and GitHub packages with each tagged release. If you do not have Nix installed
|
||||||
on your system, you may run neovim within a container using your favorite tool.
|
on your system, you may run neovim within a container using your favorite tool.
|
||||||
The following command will open the current directory in neovim with necessary tools bootstrapped.
|
The following command will open the current directory in neovim with necessary
|
||||||
|
tools bootstrapped.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
docker run -v `pwd`:/home/neovim/demo --rm -it notashelf/neovim-flake:latest
|
docker run -v `pwd`:/home/neovim/demo --rm -it notashelf/neovim-flake:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
The available registeres are `ghcr.io` and `dockerhub` for the time being. Adjust to your liking.
|
The available registeres are `ghcr.io` and `dockerhub` for the time being.
|
||||||
|
Adjust to your liking.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
See the [neovim-flake Manual](https://notashelf.github.io/neovim-flake/) for detailed installation guides, configurations, available options, release notes
|
See the [neovim-flake Manual](https://notashelf.github.io/neovim-flake/) for
|
||||||
and more.
|
detailed installation guides, configurations, available options, release notes
|
||||||
|
and more. Tips for installing userspace plugins is also contained in the
|
||||||
|
documentation.
|
||||||
|
|
||||||
If you want to dive right into trying **neovim-flake** you can get a fully featured configuration with `nix`
|
If you want to dive right into trying **neovim-flake** you can get a fully
|
||||||
language support by running:
|
featured configuration with `nix` language support by running:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
nix run github:notashelf/neovim-flake
|
nix run github:notashelf/neovim-flake
|
||||||
```
|
```
|
||||||
|
|
||||||
Please create an issue on the [issue tracker](../../../issues) if you find the documentation lacking or confusing.
|
Please create an issue on the [issue tracker](../../../issues) if you find
|
||||||
I also appreciate any contributions to the documentation.
|
the documentation lacking or confusing. I also appreciate any contributions
|
||||||
|
to the documentation.
|
||||||
|
|
||||||
## Help
|
## Help
|
||||||
|
|
||||||
You can create an issue on the [issue tracker](../../../issues) to ask questions or report bugs.
|
You can create an issue on the [issue tracker](../../../issues) to ask questions
|
||||||
I am not yet on spaces like matrix or IRC, so please use the issue tracker for now.
|
or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue
|
||||||
|
tracker for now.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
I am always looking for new ways to help improve this flake. If you would like to contribute, please read
|
I am always looking for new ways to help improve this flake. If you would like
|
||||||
the [contributing guide](CONTRIBUTING.md) before submitting a pull request. You can also create an
|
to contribute, please read the [contributing guide](CONTRIBUTING.md) before
|
||||||
issue on the [issue tracker](../../../issues) before submitting a pull request if you would like to discuss
|
submitting a pull request. You can also create an issue on the
|
||||||
a feature or bug fix.
|
[issue tracker](../../../issues) before submitting a pull request if you would
|
||||||
|
like to discuss a feature or bug fix.
|
||||||
|
|
||||||
## Philosophy
|
## Philosophy
|
||||||
|
|
||||||
The philosophy behind this flake configuration is to create an easily configurable and reproducible Neovim environment.
|
The philosophy behind this flake configuration is to create an easily
|
||||||
While it does sacrifice in size (which I know some users will find _disagreeable_), it offers a lot of flexibility and customizability in
|
configurable and reproducible Neovim environment. While it does sacrifice in
|
||||||
exchange for the large size of the flake inputs. The "KISS" (Keep it simple, stupid) principle has mostly been abandoned here, however, you _can_
|
size (which I know some users will find _disagreeable_), it offers a lot of
|
||||||
ultimately leverage the flexibility of this flake to declare a configuration that follows KISS principles, as it is very easy to bring your
|
flexibility and customizability in exchange for the large size of the flake
|
||||||
own plugins and configurations from non-nix. What this flake is meant to be does eventually fall into your hands. Whether you are a
|
inputs. The "KISS" (Keep it simple, stupid) principle has mostly been abandoned
|
||||||
developer, writer, or live coder, you can quickly craft a config that suits every project's need. Think of it like a distribution of Neovim that you have
|
here, however, you _can_ ultimately leverage the flexibility of this flake to
|
||||||
full control over. A distribution that takes advantage of pinning vim plugins and third party dependencies (such as tree-sitter grammars, language servers, and more).
|
declare a configuration that follows KISS principles, as it is very easy to
|
||||||
|
bring your own plugins and configurations from non-nix. What this flake is
|
||||||
|
meant to be does eventually fall into your hands. Whether you are a developer,
|
||||||
|
writer, or live coder, you can quickly craft a config that suits every project's
|
||||||
|
needs. Think of it like a distribution of Neovim that you have full control over.
|
||||||
|
|
||||||
One should never get a broken config when setting options. If setting multiple options results in a broken Neovim, file an issue!
|
A distribution that takes advantage of pinning vim plugins and third party
|
||||||
Each plugin knows when another plugin which allows for smart configuration of keybindings and automatic setup of things
|
dependencies (such as tree-sitter grammars, language servers, and more).
|
||||||
like completion sources and languages.
|
|
||||||
|
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.
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
**Q**: Why is this flake so big?
|
**Q**: Why is this flake so big?
|
||||||
<br/>
|
<br/>
|
||||||
**A**: I have sacrificed in size in order to provide a highly configurable and reproducible Neovim environment. A binary cache is provided to
|
**A**: I have sacrificed in size in order to provide a highly configurable and
|
||||||
eleminate the need to build the flake from source, but it is still a large flake. If you do not need all the features, you can use the default `nix` output
|
reproducible Neovim environment. A binary cache is provided to eleminate the
|
||||||
instead of the `maximal` output. This will reduce size by a lot, but you will lose some language specific features.
|
need to build the flake from source, but it is still a large flake. If you do
|
||||||
|
not need all the features, you can use the default `nix` output instead of the
|
||||||
|
`maximal` output. This will reduce size by a lot, but you will lose some
|
||||||
|
language specific features.
|
||||||
<br/><br/>
|
<br/><br/>
|
||||||
|
|
||||||
**Q**: Will you try to make this flake smaller?
|
**Q**: Will you try to make this flake smaller?
|
||||||
<br/>
|
<br/>
|
||||||
**A**: Yes. As a matter of fact, I am actively working on making this flake smaller. Unfortunately the process of providing everything
|
**A**: Yes. As a matter of fact, I am actively working on making this flake
|
||||||
possible by itself makes the flake large. Best I can do is to optimize the flake as much as possible by selecting plugins that
|
smaller. Unfortunately the process of providing everything possible by itself
|
||||||
are small and fast. And the binary cache, so at least you don't have to build it from source.
|
makes the flake large. Best I can do is to optimize the flake as much as
|
||||||
|
possible by selecting plugins that are small and fast. And the binary cache, so
|
||||||
|
at least you don't have to build it from source.
|
||||||
<br/><br/>
|
<br/><br/>
|
||||||
|
|
||||||
**Q**: Will you use a plugin manager/language server installer?
|
**Q**: Will you use a plugin manager/language server installer?
|
||||||
<br/>
|
<br/>
|
||||||
**A**: No. If you feel the need to ask that question, then you have missed the whole point of using nix and ultimately this flake.
|
**A**: No. If you feel the need to ask that question, then you have missed the
|
||||||
The whole reason we use nix is to be able to handle EVERYTHING declaratively, well including the LSP and plugin installations.
|
whole point of using nix and ultimately this flake. The whole reason we use nix
|
||||||
|
is to be able to handle EVERYTHING declaratively, well including the LSP and
|
||||||
|
plugin installations.
|
||||||
<br/><br/>
|
<br/><br/>
|
||||||
|
|
||||||
**Q**: Can you add _X_?
|
**Q**: Can you add _X_?
|
||||||
<br/>
|
<br/>
|
||||||
**A**: Maybe. Open an issue using the appropriate template and I will consider it. I do not intend to
|
**A**: Maybe. Open an issue using the appropriate template and I will consider
|
||||||
add _every plugin that is in existence_, but I will consider it, should it offer something useful to the flake.
|
it. I do not intend to add _every plugin that is in existence_, but I will
|
||||||
|
consider it, should it offer something useful to the flake.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
|
@ -180,14 +214,16 @@ and everyone who has submitted issues or pull requests!
|
||||||
|
|
||||||
### Inspiration
|
### Inspiration
|
||||||
|
|
||||||
This configuration borrows from and is based on a few other configurations, including:
|
This configuration borrows from and is based on a few other configurations,
|
||||||
|
including:
|
||||||
|
|
||||||
- [@jordanisaacs's](https://github.com/jordanisaacs) [neovim-flake](https://github.com/jordanisaacs/neovim-flake) that this flake is originally based on.
|
- [@jordanisaacs's](https://github.com/jordanisaacs) [neovim-flake](https://github.com/jordanisaacs/neovim-flake) that this flake is originally based on.
|
||||||
- [@sioodmy's](https://github.com/sioodmy) [dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design choices.
|
- [@sioodmy's](https://github.com/sioodmy) [dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design choices.
|
||||||
- [@wiltaylor's](https://github.com/wiltaylor) [neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and design ideas.
|
- [@wiltaylor's](https://github.com/wiltaylor) [neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and design ideas.
|
||||||
- [@gvolpe's](https://github.com/gvolpe) [neovim-flake](https://github.com/gvolpe/neovim-flake) for plugin, design and nix concepts.
|
- [@gvolpe's](https://github.com/gvolpe) [neovim-flake](https://github.com/gvolpe/neovim-flake) for plugin, design and nix concepts.
|
||||||
|
|
||||||
I am grateful for their previous work and inspiration, and I wholeheartedly recommend checking their work out.
|
I am grateful for their previous work and inspiration, and I wholeheartedly
|
||||||
|
recommend checking their work out.
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
Loading…
Reference in a new issue