mirror of https://github.com/LazyVim/starter
docs(readme): add installation instructions for dependencies and tools
parent
56e171ed49
commit
26a2bbbef2
|
@ -6,3 +6,5 @@ debug
|
|||
foo.*
|
||||
*.log
|
||||
data
|
||||
lua/plugins/.example.lua.swp
|
||||
lua/plugins/.example.lua.swp
|
||||
|
|
61
README.md
61
README.md
|
@ -1,4 +1,59 @@
|
|||
# 💤 LazyVim
|
||||
# Fork Information
|
||||
|
||||
A starter template for [LazyVim](https://github.com/LazyVim/LazyVim).
|
||||
Refer to the [documentation](https://lazyvim.github.io/installation) to get started.
|
||||
### Optional: Required Dependencies to Run tex Formatter
|
||||
To use the `tex formatter`, install the following Perl modules:
|
||||
```bash
|
||||
brew install cpanminus
|
||||
sudo cpanm File::HomeDir File::Which YAML::Tiny
|
||||
```
|
||||
|
||||
### Optional: Install lazygit
|
||||
To install `lazygit`, use:
|
||||
```bash
|
||||
brew install lazygit
|
||||
```
|
||||
To launch, use `<leader>gg`.
|
||||
|
||||
### Mandatory: Reverse Search Configuration
|
||||
1. Install the `neovim-remote` package:
|
||||
```bash
|
||||
pip install neovim-remote
|
||||
```
|
||||
2. Start Neovide with the following command:
|
||||
```bash
|
||||
neovide -- --listen /tmp/nvimsocket
|
||||
```
|
||||
Use this command for future launches.
|
||||
3. Configure Sync settings in `skim`:
|
||||
- Command:
|
||||
```bash
|
||||
which nvr
|
||||
```
|
||||
This will output a path like `/Users/yourname/.local/bin/nvr`. Use this as the command.
|
||||
- Parameters:
|
||||
```bash
|
||||
--servername /tmp/nvimsocket +"%line" "%file"
|
||||
```
|
||||
4. Create an alias for convenience:
|
||||
```bash
|
||||
alias neovide="neovide -- --listen /tmp/nvimsocket"
|
||||
```
|
||||
|
||||
### Optional: Install Stylua
|
||||
Stylua is an optional code formatter you can install.
|
||||
|
||||
### Optional: Install fd
|
||||
`fd` is a file search system. Install it using:
|
||||
```bash
|
||||
brew install fd
|
||||
```
|
||||
|
||||
### Install coc.nvim
|
||||
1. Navigate to `~/.local/share/nvim/lazy/coc.nvim`:
|
||||
```bash
|
||||
cd ~/.local/share/nvim/lazy/coc.nvim
|
||||
```
|
||||
2. Run the following commands:
|
||||
```bash
|
||||
yarn install
|
||||
yarn build
|
||||
|
|
Binary file not shown.
Loading…
Reference in New Issue