Skip to content

Commit

Permalink
docs: clean up remaining mentions of neovim-flake
Browse files Browse the repository at this point in the history
  • Loading branch information
@NotAShelf
NotAShelf committed Apr 27, 2024
1 parent 97a64ab commit 40979a6
Show file tree
Hide file tree
Showing 7 changed files with 438 additions and 93 deletions.
126 changes: 38 additions & 88 deletions .github/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
<div align="center">
<img src=".github/assets/neovim-flake-logo-work.svg" alt="neovim-flake Logo" width="200">
<img src=".github/assets/nvf-logo-work.svg" alt="nvf Logo" width="200">
</div>
<h1 align="center">❄️ neovim-flake</h1>
<h1 align="center">❄️ nvf</h1>
<div align="center">
<p>
<a href="https://github.com/NotAShelf/neovim-flake/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/NotAShelf/neovim-flake?style=for-the-badge&logo=nixos&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />
<a href="https://github.com/NotAShelf/nvf/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/NotAShelf/nvf?style=for-the-badge&logo=nixos&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/NotAShelf/neovim-flake/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/NotAShelf/neovim-flake?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
<a href="https://github.com/NotAShelf/nvf/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/NotAShelf/nvf?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/NotAShelf/neovim-flake/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/NotAShelf/neovim-flake?style=for-the-badge&logo=nixos&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
<a href="https://github.com/NotAShelf/nvf/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/NotAShelf/nvf?style=for-the-badge&logo=nixos&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/NotAShelf/neovim-flake/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/NotAShelf/neovim-flake?style=for-the-badge&logo=nixos&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
<a href="https://github.com/NotAShelf/nvf/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/NotAShelf/nvf?style=for-the-badge&logo=nixos&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/NotAShelf/neovim-flake/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/NotAShelf/neovim-flake?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
<a href="https://github.com/NotAShelf/nvf/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/NotAShelf/nvf?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/NotAShelf/neovim-flake">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/NotAShelf/neovim-flake?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
<a href="https://github.com/NotAShelf/nvf">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/NotAShelf/nvf?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
</a>
</p>

<p align="center">
<img src="https://stars.medv.io/NotAShelf/neovim-flake.svg", title="stars"/>
<img src="https://stars.medv.io/NotAShelf/nvf.svg", title="stars"/>
</p>

<div align="center">
<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
framework 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>
Expand Down Expand Up @@ -69,7 +69,7 @@ If you would like to try out the configuration before even thinking about
installing it, you can run the following command

```console
nix run github:notashelf/neovim-flake
nix run github:notashelf/nvf
```

This will get you a feel for the base configuration and UI design.
Expand All @@ -81,7 +81,7 @@ 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
nix run github:notashelf/neovim-flake#tidal
nix run github:notashelf/nvf#tidal
```

Similar instructions will apply for `nix profile install`. However, you are
Expand All @@ -93,33 +93,18 @@ recommended to instead use the module system as described in the manual.
> configurations. Should you choose to try out the `maximal` configuration,
> using the binary cache as described in the manual is _strongly_ recommended.
### 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
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.

```console
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.

## Documentation

See the [neovim-flake Manual](https://notashelf.github.io/neovim-flake/) for
See the [**nvf** Manual](https://notashelf.github.io/nvf/) for
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
If you want to dive right into trying **nvf** you can get a fully
featured configuration with `nix` language support by running:

```console
nix run github:notashelf/neovim-flake
nix run github:notashelf/nvf#nix
```

Please create an issue on the [issue tracker](../../../issues) if you find
Expand All @@ -140,62 +125,21 @@ submitting a pull request. You can also create an issue on the
[issue tracker](../../../issues) before submitting a pull request if you would
like to discuss a feature or bug fix.

## Philosophy

The philosophy behind this flake configuration is to create an easily
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 customizability 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_ ultimately leverage the flexibility of this flake to
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.

A distribution that takes advantage of pinning vim plugins and third party
dependencies (such as tree-sitter grammars, language servers, and more).

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

**Q**: Why is this flake so big?
<br/>
**A**: I have sacrificed in size in order to provide a highly configurable and
reproducible Neovim environment. A binary cache is provided to 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 instead of the
`maximal` output. This will reduce size by a lot, but you will lose some
language specific features.
<br/><br/>

**Q**: Will you try to make this flake smaller?
<br/>
**A**: Yes. As a matter of fact, I am actively working on making this flake
smaller. Unfortunately the process of providing everything possible by itself
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/>

**Q**: Will you use a plugin manager/language server installer?
**Q**: Can you add _X_?
<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. The whole reason we use nix
is to be able to handle EVERYTHING declaratively, well including the LSP and
plugin installations.
<br/><br/>
**A**: Maybe! It is not one of our goals to support each and every Neovim
plugin, however, I am always open to new modules and plugin setup additions
to **nvf**. Use the [appropritate issue
template](https://github.com/NotAShelf/nvf/issues/new/choose) and I will
consider a module addition.

**Q**: Can you add _X_?
**Q**: A plugin I need is not available in **nvf**. What to do?
<br/>
**A**: Maybe. Open an issue using the appropriate template and I will consider
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.
**A**: **nvf** exposes several APIs for you to be able to add your own
plugin configurations! Please see the documentation on how you may do
this.

## Credits

Expand All @@ -207,7 +151,7 @@ Special thanks to
- [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to work
- [@n3oney](https://github.com/n3oney) - For making custom keybinds finally possible
- [@horriblename](https://github.com/horriblename) - For actively implementing planned features and quality of life updates
- [@Yavko](https://github.com/Yavko) - For the amazing neovim-flake logo
- [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo
- [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I could not

and everyone who has submitted issues or pull requests!
Expand All @@ -226,4 +170,10 @@ I am grateful for their previous work and inspiration, and I wholeheartedly
recommend checking their work out.
<br/>

## License

Following the [original neovim-flake](https://github.com/jordanisaacs/neovim-flake)
**nvf** has been made available under the **MIT License**. However, all assets
are published under the [CC BY License].

---
Loading

0 comments on commit 40979a6

Please sign in to comment.