Files
Neolite/README.md
Arkaprabha Chakraborty 312fd85ea3 Update the README with better explanation about the project
Changes to be committed:
      modified:   README.md
2023-03-11 00:43:18 +05:30

47 lines
1.3 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
![neolite.png](blob/neolite.png)
# About
Neolite is a fast and lightweight configuration of Neovim. For the uninitiated, Neovim is a terminal based text editor which can be extended using a scripting language like [Lua](https://www.lua.org/about.html). Neovim out-of-the-box doesn't come with a lot of features, but it is highly extensible. It also comes with built-in LSP support and has been in use forever, unlike some other editors ([Atom](<https://en.wikipedia.org/wiki/Atom_(text_editor)>)). So when you use it, you can be sure that it will be supported for a long time.
# Dependencies
- [cURL](https://github.com/curl/curl)
- [Git](https://github.com/git/git)
- [Neovim](https://github.com/neovim/neovim)
# Optional Dependencies
- [npm](https://github.com/npm/cli)
- [Lazygit](https://github.com/jesseduffield/lazygit)
# Quick Start
Once you have all the dependencies sorted, run the command below and we'll take care of the rest.
```
curl -sLf https://raw.githubusercontent.com/arkorty/neolite/master/install.sh | bash
```
# Screenshots
### File Tree & Active Buffer
![file-tree.png](blob/file-tree.png)
### Fuzzy Finder
![fuzzy-finder.png](blob/fuzzy-finder.png)
### Terminal & Lazygit
![lazygit.png](blob/lazygit.png)
### Live Grep
![live-grep.png](blob/live-grep.png)
# License
- [MIT License](LICENSE)