docs: improve project readme

This commit is contained in:
NotAShelf 2023-04-15 11:33:14 +03:00
parent 158a74e00d
commit c466775789
No known key found for this signature in database
GPG key ID: F0D14CCB5ED5AA22

10
.github/README.md vendored
View file

@ -123,22 +123,26 @@ instead of the `maximal` output. This will reduce size by a lot, but you will lo
**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?
**Q**: Will you use a plugin manager/language server installer?
<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. We load plugins with raw lua.
**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/>
**Q**: Can you add *X*?
<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**: 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.
## Credits
### Contributors
Special thanks to
- [@fufexan](https://github.com/fufexan) - For the transition to flake-parts
- [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to work
and everyone who has submitted issues or pull requests!
### Inspiration
This configuration borrows from and is based on a few other configurations, including: