docs: improvements
This commit is contained in:
parent
7b5bef9f1a
commit
5aa0ca76d3
10
README.md
10
README.md
|
@ -1,11 +1,19 @@
|
||||||
# radiant.nvim
|
# radiant.nvim
|
||||||
`radiant.nvim` is a fast and minimal Neovim configuration framework; it aims to:
|
`radiant.nvim` is a fast and minimal Neovim configuration framework; it aims to:
|
||||||
|
|
||||||
- Provide a solid base for *your* own configuration
|
- Provide a solid base for *your* own configuration
|
||||||
- Help to make tailoring the Neovim experience simple and quick
|
- Help to make tailoring the Neovim experience simple and quick
|
||||||
- Create a consistent text editing experience for various common formats and files
|
- Create a consistent text editing experience for various common formats and files
|
||||||
- [Be beautiful!](https://git.devraza.duckdns.org/devraza/kagayaki.nvim)
|
- [Be beautiful!](https://git.devraza.duckdns.org/devraza/kagayaki.nvim)
|
||||||
|
|
||||||
|
> **Keep in mind that this configuration isn't complete. Development has a long way to go before I can even say the above is true**.
|
||||||
|
|
||||||
|
> For the time being, installing packages must be done externally (I do it via my NixOS home-manager configuration). I'll turn this configuration into a flake for better accessibility when I feel the need to - though anyone reading this is welcome to request this happen sooner.
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
![Image of desktop with several Neovide windows showing the neovim configuration](./assets/screenshot.png)
|
![Image of desktop with a few Neovide windows showing the neovim configuration](./assets/screenshot.png)
|
||||||
|
|
||||||
This project is in its early stages of development. I consider it to be a functional text editor, but it still lacks a lot of features and isn't very mature. Stay tuned!
|
This project is in its early stages of development. I consider it to be a functional text editor, but it still lacks a lot of features and isn't very mature. Stay tuned!
|
||||||
|
|
||||||
|
## Notes in Neovim
|
||||||
|
This configuration has integrated support for [Neorg](https://github.com/nvim-neorg/neorg) by default - I recommend you check the official repository out if you intend to write notes in Neovim.
|
||||||
|
|
Loading…
Reference in a new issue