From 7e596c318431aa2475254e29db7caf6bc029bd7c Mon Sep 17 00:00:00 2001 From: ralvescosta Date: Sat, 12 Apr 2025 12:16:50 -0300 Subject: [PATCH] feat: readme --- README.md | 84 +++++++++++-------------------------------------------- 1 file changed, 16 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 16695c83..34bf4868 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ External Requirements: > See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes > and quick install snippets -### Install Kickstart +### Install ralvescosta nvim > **NOTE** > [Backup](#FAQ) your previous configuration (if any exists) @@ -46,9 +46,7 @@ Neovim's configurations are located under the following paths, depending on your | OS | PATH | | :- | :--- | -| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` | -| Windows (cmd)| `%localappdata%\nvim\` | -| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` | +| Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` | #### Recommended Step @@ -64,34 +62,13 @@ You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file too - it's ignored in the kickstart repo to make maintenance easier, but it's [recommended to track it in version control](https://lazy.folke.io/usage/lockfile). -#### Clone kickstart.nvim +#### Clone ralvescosta.nvim > **NOTE** > If following the recommended step above (i.e., forking the repo), replace > `nvim-lua` with `` in the commands below -
Linux and Mac - ```sh -git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim -``` - -
- -
Windows - -If you're using `cmd.exe`: - -``` -git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim" -``` - -If you're using `powershell.exe` - -``` -git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim" -``` - -
+git clone https://github.com:ralvescosta/nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim ### Post Installation @@ -154,48 +131,7 @@ Below you can find OS specific install instructions for Neovim and dependencies. After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step. -#### Windows Installation -
Windows with Microsoft C++ Build Tools and CMake -Installation may require installing build tools and updating the run command for `telescope-fzf-native` - -See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation) - -This requires: - -- Install CMake and the Microsoft C++ Build Tools on Windows - -```lua -{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' } -``` -
-
Windows with gcc/make using chocolatey -Alternatively, one can install gcc and make which don't require changing the config, -the easiest way is to use choco: - -1. install [chocolatey](https://chocolatey.org/install) -either follow the instructions on the page or use winget, -run in cmd as **admin**: -``` -winget install --accept-source-agreements chocolatey.chocolatey -``` - -2. install all requirements using choco, exit the previous cmd and -open a new one so that choco path is set, and run in cmd as **admin**: -``` -choco install -y neovim git ripgrep wget fd unzip gzip mingw make -``` -
-
WSL (Windows Subsystem for Linux) - -``` -wsl --install -wsl -sudo add-apt-repository ppa:neovim-ppa/unstable -y -sudo apt update -sudo apt install make gcc ripgrep unzip git xclip neovim -``` -
#### Linux Install
Ubuntu Install Steps @@ -211,6 +147,18 @@ sudo apt install make gcc ripgrep unzip git xclip neovim ``` sudo apt update sudo apt install make gcc ripgrep unzip git xclip curl +go install github.com/jesseduffield/lazygit@latest +go install github.com/google/yamlfmt/cmd/yamlfmt@latest +go install github.com/jessfraz/dockfmt@latest +go install golang.org/x/tools/cmd/goimports@latest +go install github.com/jesseduffield/lazydocker@latest +asdf reshim golang +npm install -g cspell +asdf reshim nodejs +cargo install taplo-cli +sudo sysctl -w fs.inotify.max_user_watches=1048576 +sudo sysctl -w fs.inotify.max_user_instances=1024 +sudo sysctl -p # Now we install nvim curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz