feat(nvim): README
This commit is contained in:
parent
fb2b1e6d0e
commit
2e70d62e65
3 changed files with 57 additions and 18 deletions
56
README.md
56
README.md
|
@ -1,37 +1,65 @@
|
||||||
# Home Directory Configuration
|
# home directory configuration
|
||||||
This is my personal linux home directory configuration.
|
this is my personal linux home directory configuration.
|
||||||
|
|
||||||
Use at your own risk!
|
use at your own risk!
|
||||||
|
|
||||||
## Quickstart
|
## quickstart
|
||||||
|
|
||||||
Setting up this configuration is as simple as it gets:
|
setting up this configuration is as simple as it gets:
|
||||||
``` bash
|
``` bash
|
||||||
git clone https://git.nold.in/nold/dotfiles
|
git clone https://git.nold.in/nold/dotfiles
|
||||||
cd dotfiles && bash setup.sh
|
cd dotfiles && bash setup.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
To Update everything just run `setup.sh` again.
|
to update everything just run `setup.sh` again.
|
||||||
|
|
||||||
## Structure
|
## structure
|
||||||
|
|
||||||
### bashrc
|
### bashrc
|
||||||
... well ... `~/.bashrc`... will not be linked unlike files contained in `dotfiles` directory, but `source`d. Leaving the local `~/.bashrc` intact.
|
... well ... `~/.bashrc`... will not be linked unlike files contained in `dotfiles` directory, but `source`d. leaving the local `~/.bashrc` intact.
|
||||||
|
|
||||||
### config
|
### config
|
||||||
Directories the will be linked to `~/.config/${name}`.
|
directories the will be linked to `~/.config/${name}`.
|
||||||
|
|
||||||
### configfile
|
### configfile
|
||||||
Only files from this directory tree will be linked, to the same directory under `~/.config`
|
only files from this directory tree will be linked, to the same directory under `~/.config`
|
||||||
|
|
||||||
### dotfiles
|
### dotfiles
|
||||||
Files that are directly located under `$HOME`.
|
files that are directly located under `$home`.
|
||||||
|
|
||||||
### fonts
|
### fonts
|
||||||
Fonts that will be copied to `~/.fonts`
|
fonts that will be copied to `~/.fonts`
|
||||||
|
|
||||||
### hosts
|
### hosts
|
||||||
Custom additions to bashrc for specific hostnames. If no specific host is found in `hosts/$(hostname -s)`, `any` will be used.
|
custom additions to bashrc for specific hostnames. if no specific host is found in `hosts/$(hostname -s)`, `any` will be used.
|
||||||
|
|
||||||
### requirements.txt
|
### requirements.txt
|
||||||
Python libs to install using `pip3`.
|
python libs to install using `pip3`.
|
||||||
|
|
||||||
|
|
||||||
|
## neovim
|
||||||
|
|
||||||
|
### help
|
||||||
|
|
||||||
|
`<space + ?|tk>` - teleskope keymappings
|
||||||
|
|
||||||
|
### navigation
|
||||||
|
|
||||||
|
`<ctrl+n>` - toggle nvtree
|
||||||
|
|
||||||
|
### editing
|
||||||
|
|
||||||
|
`<space + />`- toggle comment_
|
||||||
|
|
||||||
|
### tabs
|
||||||
|
`<tab>` - next tab
|
||||||
|
`<shift+tab>` - prev tab_
|
||||||
|
|
||||||
|
### terminal
|
||||||
|
|
||||||
|
`<alt+h>` - horizontal terminal
|
||||||
|
`<alt+v>` - vertical terminal
|
||||||
|
|
||||||
|
### system
|
||||||
|
|
||||||
|
`<Space + uu>` - Update NvChad
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
-- ChadRC.lua
|
-- ChadRC.lua
|
||||||
local M = {}
|
local M = {}
|
||||||
|
|
||||||
|
@ -13,7 +12,13 @@ M.ui = {
|
||||||
|
|
||||||
M.plugins = require "custom.plugins"
|
M.plugins = require "custom.plugins"
|
||||||
|
|
||||||
-- M.mappings = {
|
M.mappings = {
|
||||||
|
teleskope = {
|
||||||
|
n = {
|
||||||
|
["<leader>?"] = { "<cmd> Telescope keymaps <CR>", "show keys" },
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
-- -- custom = {}, -- custom user mappings
|
-- -- custom = {}, -- custom user mappings
|
||||||
--
|
--
|
||||||
-- custom = {
|
-- custom = {
|
||||||
|
@ -22,7 +27,7 @@ M.plugins = require "custom.plugins"
|
||||||
-- update_nvchad = "<leader>uu",
|
-- update_nvchad = "<leader>uu",
|
||||||
-- new_tab = "<leader>t",
|
-- new_tab = "<leader>t",
|
||||||
-- },
|
-- },
|
||||||
-- }
|
}
|
||||||
|
|
||||||
return M
|
return M
|
||||||
|
|
||||||
|
|
|
@ -31,6 +31,12 @@ return {
|
||||||
separator_style = "arrow", -- default/round/block/arrow
|
separator_style = "arrow", -- default/round/block/arrow
|
||||||
overriden_modules = nil,
|
overriden_modules = nil,
|
||||||
},
|
},
|
||||||
|
-- lazyload it when there are 1+ buffers
|
||||||
|
tabufline = {
|
||||||
|
enabled = true,
|
||||||
|
lazyload = true,
|
||||||
|
overriden_modules = nil,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue