Edited thge README.md file.
This commit is contained in:
parent
2623f954f2
commit
29497a5a6f
1 changed files with 21 additions and 6 deletions
27
README.md
27
README.md
|
|
@ -1,9 +1,24 @@
|
|||
**This repo is supposed to be used as config by NvChad users!**
|
||||
# Usage on other computers
|
||||
|
||||
- The main nvchad repo (NvChad/NvChad) is used as a plugin by this repo.
|
||||
- So you just import its modules , like `require "nvchad.options" , require "nvchad.mappings"`
|
||||
- So you can delete the .git from this repo ( when you clone it locally ) or fork it :)
|
||||
**Backup anything that might already be there (just in case)**
|
||||
mv ~/.config/nvim ~/.config/nvim.bak 2>/dev/null || true
|
||||
|
||||
# Credits
|
||||
**Clone fresh**
|
||||
git clone git@forgejo.yourserver.com:yourusername/nvim-config.git ~/.config/nvim
|
||||
|
||||
1) Lazyvim starter https://github.com/LazyVim/starter as nvchad's starter was inspired by Lazyvim's . It made a lot of things easier!
|
||||
**Enter the folder and let Lazy bootstrap everything**
|
||||
cd ~/.config/nvim
|
||||
nvim-config
|
||||
|
||||
# Tips
|
||||
|
||||
- After you change anything on one machine (init.lua, a snippet, a new plugin, etc.), just do:
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "chore: update markdown folding / add new snippet"
|
||||
git push
|
||||
```
|
||||
|
||||
- On the other machines: `git pull` inside `~/.config/nvim` (or even better, add a small alias: `alias nvimup='cd ~/.config/nvim && git pull'`).
|
||||
- If you ever add new snippets or templates, they live in `lua/custom/snippets/` → they will automatically travel with the repo.
|
||||
- `lazy-lock.json` is committed → every machine gets the exact same plugin versions.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue