From 1b6c7bdf45a52c575493fe8486f7e4cdba593776 Mon Sep 17 00:00:00 2001 From: Franchioping Date: Wed, 29 Oct 2025 17:57:46 +0000 Subject: [PATCH] readme repo change --- README.md | 45 +++++++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 31df068..57d4191 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # kickstart.nvim - - ```sh -git clone git@github.com:franchioping/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim +git clone ssh://git@forgejo.galard.uk:222/franchioping/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim ``` ## Introduction @@ -28,24 +26,24 @@ If you are experiencing issues, please make sure you have the latest versions. ### Install External Dependencies External Requirements: -- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`) -- [ripgrep](https://github.com/BurntSushi/ripgrep#installation) -- Clipboard tool (xclip/xsel/win32yank or other depending on the platform) -- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons - - if you have it set `vim.g.have_nerd_font` in `init.lua` to true -- Language Setup: - - If you want to write Typescript, you need `npm` - - If you want to write Golang, you will need `go` - - etc. +* Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`) +* [ripgrep](https://github.com/BurntSushi/ripgrep#installation) +* Clipboard tool (xclip/xsel/win32yank or other depending on the platform) +* A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons + * if you have it set `vim.g.have_nerd_font` in `init.lua` to true +* Language Setup: + * If you want to write Typescript, you need `npm` + * If you want to write Golang, you will need `go` + * etc. > **NOTE** -> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes +> See [Install Recipes](#install-recipes) for additional Windows and Linux specific notes > and quick install snippets ### Install Kickstart > **NOTE** -> [Backup](#FAQ) your previous configuration (if any exists) +> [Backup](#faq) your previous configuration (if any exists) Neovim's configurations are located under the following paths, depending on your OS: @@ -70,6 +68,7 @@ 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 +> > **NOTE** > If following the recommended step above (i.e., forking the repo), replace > `nvim-lua` with `` in the commands below @@ -118,7 +117,6 @@ examples of adding popularly requested plugins. > [!NOTE] > For more information about a particular plugin check its repository's documentation. - ### Getting Started [The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o) @@ -133,9 +131,11 @@ examples of adding popularly requested plugins. * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example, you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias: + ``` alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim' ``` + When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim @@ -157,7 +157,7 @@ examples of adding popularly requested plugins. 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. +After installing all the dependencies continue with the [Install Kickstart](#install-kickstart) step. #### Windows Installation @@ -168,11 +168,12 @@ See `telescope-fzf-native` documentation for [more details](https://github.com/n This requires: -- Install CMake and the Microsoft C++ Build Tools on Windows +* 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, @@ -181,15 +182,18 @@ 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) @@ -200,9 +204,11 @@ 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 ``` @@ -210,6 +216,7 @@ sudo add-apt-repository ppa:neovim-ppa/unstable -y sudo apt update sudo apt install make gcc ripgrep unzip git xclip neovim ``` +
Debian Install Steps @@ -227,12 +234,14 @@ sudo tar -C /opt -xzf nvim-linux64.tar.gz # make it available in /usr/local/bin, distro installs to /usr/bin sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/ ``` +
Fedora Install Steps ``` sudo dnf install -y gcc make git ripgrep fd-find unzip neovim ``` +
Arch Install Steps @@ -240,5 +249,5 @@ sudo dnf install -y gcc make git ripgrep fd-find unzip neovim ``` sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim ``` -
+