docs: added README.md
This commit is contained in:
parent
4e74a6b9b2
commit
bc9c50b688
1 changed files with 30 additions and 1 deletions
31
README.md
31
README.md
|
@ -1,2 +1,31 @@
|
|||
# tinker.nvim
|
||||
a simple but complete neovim config for those who cannot stop tinkering
|
||||
> a simple but complete neovim config for those who cannot stop tinkering
|
||||
|
||||
### demo
|
||||
![config demo gif](https://cdn.alemi.dev/proj/tinker.nvim/demo.gif)
|
||||
|
||||
## installation
|
||||
just `git clone https://git.alemi.dev/tinker.nvim nvim` inside your `.config` dir
|
||||
|
||||
first boot will throw errors, close and reopen
|
||||
|
||||
to sync plugins use `:Lazy` and then `S`
|
||||
|
||||
keep config up-to-date with `:UpdateConfig`
|
||||
|
||||
|
||||
## included
|
||||
* custom statusline
|
||||
* custom session wrapper (wip)
|
||||
* custom keybinds
|
||||
* custom colorscheme (peak.nvim by me)
|
||||
* plugins, such as
|
||||
* nvim-treesitter
|
||||
* nvim-lspconfig
|
||||
* telescope.nvim + dressing.nvim
|
||||
* nvim-cmp
|
||||
* nvim-dap
|
||||
* vim-fugitive + gitsigns.nvim
|
||||
* neo-tree.nvim
|
||||
* hexmode
|
||||
* vim-combo (by me)
|
||||
|
|
Loading…
Reference in a new issue