NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-22 13:20:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: re-format README; clean up sections (#387)

Browse source 
* docs: re-format README; clean up sections

* docs: update README with features section
This commit is contained in:
raf 2024-09-28 20:36:07 +00:00 committed by GitHub
parent cef3aefabb
commit d6bbae1a91
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 111 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

182
.github/README.md vendored
View file

@ -33,10 +33,9 @@
<div align="center"> <div align="center">
<a> <a>
A highly modular, configurable, extensible and easy to use Neovim configuration nvf is a highly modular, configurable, extensible and easy to use Neovim configuration
framework in Nix. Designed for flexibility and ease of use, this flake in Nix. Designed for flexibility and ease of use, nvf allows you to easily configure
allows you to easily configure your Neovim instance with a few lines of your fully featured Neovim instance with a few lines of Nix.
Nix code.
</a> </a>
</div> </div>
@ -44,6 +43,7 @@
<div align="center"><p> <div align="center"><p>
[Features]: #features
[Get Started]: #get-started [Get Started]: #get-started
[Documentation]: #documentation [Documentation]: #documentation
[Help]: #help [Help]: #help
@ -51,119 +51,146 @@
[FAQ]: #faq [FAQ]: #faq
[Credits]: #credits [Credits]: #credits
**[<kbd> <br> Get Started <br> </kbd>][Get Started]** **[<kbd><br> Features <br></kbd>][Features]**
**[<kbd> <br> Documentation <br> </kbd>][Documentation]** **[<kbd><br> Get Started <br></kbd>][Get Started]**
**[<kbd> <br> Help <br> </kbd>][Help]** **[<kbd><br> Documentation <br></kbd>][Documentation]**
**[<kbd> <br> Contribute <br> </kbd>][Contribute]** **[<kbd><br> Help <br></kbd>][Help]**
**[<kbd> <br> FAQ <br> </kbd>][Faq]** **[<kbd><br> Contribute <br></kbd>][Contribute]**
**[<kbd> <br> Credits <br> </kbd>][Credits]** **[<kbd><br> FAQ <br></kbd>][Faq]** **[<kbd><br> Credits <br></kbd>][Credits]**
</p></div> </p></div>
--- ---
## Features
- **Reproducible**: Your configuration will behave the same anywhere. No
surprises, promise!
- **Portable**: nvf depends _solely_ on your Nix store, and nothing else. No
more global binaries! Works on all platforms, without hassle.
- **Customizable**: There are _almost no defaults_ to annoy you. nvf is fully
customizable through the Nix module system.
- **Well-documented**: Documentation is priority. You will never face
undocumented, obscure behaviour.
- **Idiomatic**: nvf does things _the right way_. The codebase is, and will,
remain maintainable.
## Get Started ## Get Started
### Using `nix` CLI If you are not sold on the concepts of **nvf**, and would like to try out the
default configuration before even _thinking about_ installing it, you may run
the following in order to take **nvf** out for a spin.
If you would like to try out the configuration before even thinking about ```bash
installing it, you can run the following command
```console
nix run github:notashelf/nvf nix run github:notashelf/nvf
``` ```
This will get you a feel for the base configuration and UI design. This will get you a feel for the base configuration and UI design. Though, none
The flake exposes `#nix` as the default package, providing minimal of the configuration options are final as **nvf** is designed to be modular and
language support and various utilities.You may also use `#nix`, configurable.
`#tidal` or `#maximal` to get try out different configurations.
It is as simple as changing the target output to get a different > [!TIP]
configuration. For example, to get a configuration with `tidal` support, run: > The flake exposes `#nix` as the default package, providing minimal language
> support and various utilities. You may also use the `#nix` or `#maximal`
> packages provided by the this flake to get try out different configurations.
```console It is as simple as changing the target output to get a different configuration.
nix run github:notashelf/nvf#tidal For example, to get a configuration with large language coverage, run:
```bash
nix run github:notashelf/nvf#maximal
``` ```
Similar instructions will apply for `nix profile install`. However, you are Similar instructions will apply for `nix profile install`. However, you are
recommended to instead use the module system as described in the manual. 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. > The `maximal` configuration is _massive_ and will take a while to build. To
> To get a feel for the configuration, use the default `nix` or `tidal` > get a feel for the configuration, use the default `nix` configuration. Should
> configurations. Should you choose to try out the `maximal` configuration, > you choose to try out the `maximal` configuration, using the binary cache as
> using the binary cache as described in the manual is _strongly_ recommended. > described in the manual is _strongly_ recommended.
If you are convinced, proceed to the next section to view the installation
instructions.
## Documentation ## Documentation
See the [**nvf** Manual](https://notashelf.github.io/nvf/) for [nvf manual]: https://notashelf.github.io/nvf/
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 **nvf** you can get a fully The _recommended_ way of installing **nvf** is using either the NixOS or the
featured configuration with `nix` language support by running: Home-Manager module, though it is completely possible and no less supported to
install **nvf** as a standalone package, or a flake output.
```console See the [**nvf** manual] for detailed and up-to-date installation guides,
nix run github:notashelf/nvf#nix configurations, available options, release notes and more. Tips for installing
``` userspace plugins is also contained in the documentation.
[Issues]: https://github.com/NotAShelf/nvf/issues [issue tracker]: https://github.com/NotAShelf/nvf/issues
Please create an issue on the [issue tracker](issues) if you find Please create an issue on the [issue tracker] if you find the documentation
the documentation lacking or confusing. I also appreciate any contributions lacking or confusing. Any improvements to the documentation through pull
to the documentation. requests are also welcome, and appreciated.
## Help ## Help
You can create an issue on the [issue tracker](issues) to ask questions You can create an issue on the [issue tracker] to ask questions or report bugs.
or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue I am not yet on spaces like matrix or IRC, so please use the issue tracker for
tracker for now. now.
## Contributing ## Contributing
I am always looking for new ways to help improve this flake. If you would like I am always looking for new ways to help improve this flake. If you would like
to contribute, please read the [contributing guide](CONTRIBUTING.md) before to contribute, please read the [contributing guide](CONTRIBUTING.md) before
submitting a pull request. You can also create an issue on the submitting a pull request. You can also create an issue on the [issue tracker]
[issue tracker](issues) before submitting a pull request if you would before submitting a pull request if you would like to discuss a feature or bug
like to discuss a feature or bug fix. fix.
## FAQ ## FAQ
[appropriate issue template]: https://github.com/NotAShelf/nvf/issues/new/choose
**Q**: What platforms are supported?
<br/> **A**: nvf actively supports Linux and Darwin platforms using standalone
Nix, NixOS or Home-Manager. Please take a look at the
**Q**: Can you add _X_? **Q**: Can you add _X_?
<br/> <br/> **A**: Maybe! It is not one of our goals to support each and every Neovim
**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
plugin, however, I am always open to new modules and plugin setup additions **nvf**. Use the [appropriate issue template] and I will consider a module
to **nvf**. Use the [appropritate issue template](issues/new/choose) and I will addition. As mentioned before, PRs adding new features are also welcome.
consider a module addition.
**Q**: A plugin I need is not available in **nvf**. What to do? **Q**: A plugin I need is not available in **nvf**. What to do?
<br/> <br/> **A**: **nvf** exposes several APIs for you to be able to add your own
**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.
plugin configurations! Please see the documentation on how you may do
this.
**Q**: Main branch is awfully silent, is the project dead? **Q**: Main branch is awfully silent, is the project dead?
<br/> <br/> **A**: No! Sometimes we branch out (e.g. v0.6) to avoid breaking userspace
**A**: No! Sometimes we branch out (e.g. v0.6) to avoid breaking userspace
and work in a separate branch until we make sure the new additions are and work in a separate branch until we make sure the new additions are
implemented in the most comfortable way available to the end user. If you have implemented in the most comfortable way available to the end user. If you have
not noticed any activity on the main branch, consider taking a look at the [list not noticed any activity on the main branch, consider taking a look at the
of branches](https://github.com/NotAShelf/nvf/branches=) or the [list of open [list of branches](https://github.com/NotAShelf/nvf/branches=) or the
pull requests](https://github.com/NotAShelf/nvf) [list of open pull requests](https://github.com/NotAShelf/nvf)
## Credits ## Credits
### Contributors ### Contributors
Special thanks to Special, heart-felt thanks to
- [@fufexan](https://github.com/fufexan) - For the transition to flake-parts - [@fufexan](https://github.com/fufexan) - For the transition to flake-parts
- [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to work - [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to
- [@n3oney](https://github.com/n3oney) - For making custom keybinds finally possible work
- [@horriblename](https://github.com/horriblename) - For actively implementing planned features and quality of life updates - [@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 **nvf** logo - [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo
- [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I could not - [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I
could not
- [@Diniamo](https://github.com/Diniamo) - For actively submitting PRs, pull
requests and overall assistence
- [@Gerg-l](https://github.com/gerg-l) - For the modern Neovim wrapper, mnw and
occasional code improvements
and everyone who has submitted issues or pull requests! and everyone who has submitted issues or pull requests!
@ -172,10 +199,18 @@ and everyone who has submitted issues or pull requests!
This configuration borrows from and is based on a few other configurations, This configuration borrows from and is based on a few other configurations,
including: 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)
- [@sioodmy's](https://github.com/sioodmy) [dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design choices. [neovim-flake](https://github.com/jordanisaacs/neovim-flake) that this flake
- [@wiltaylor's](https://github.com/wiltaylor) [neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and design ideas. is originally based on.
- [@gvolpe's](https://github.com/gvolpe) [neovim-flake](https://github.com/gvolpe/neovim-flake) for plugin, design and nix concepts. - [@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.
- [@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 I am grateful for their previous work and inspiration, and I wholeheartedly
recommend checking their work out. recommend checking their work out.
@ -183,11 +218,14 @@ recommend checking their work out.
## License ## License
Following the license of the [original neovim-flake](https://github.com/jordanisaacs/neovim-flake), Following the license of the
**nvf** has been made available under the [**MIT License**](LICENSE). However, all assets [original neovim-flake](https://github.com/jordanisaacs/neovim-flake), **nvf**
and documentation are published under the has been made available under the [**MIT License**](LICENSE). However, all
assets 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).
<h6>Yeah this includes the logo work too, stop stealing artwork that is not yours!</h6>
--- ---
<div align="right"> <div align="right">