john-okeefe/AstroNvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated README.md to astronvim github version with modifications

Browse Source
This commit is contained in:
john-okeefe 2024-04-11 11:30:56 -04:00
parent 90bce8fbe1
commit ad94ecc530
1 changed files with 205 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

218
README.md
View File

@ -1,11 +1,97 @@
# AstroNvim Template
<div align="center" id="madewithlua">
<img src="https://astronvim.com/logo/astronvim.svg" width="110", height="100">
</div>
**NOTE:** This is for AstroNvim v4+
<h1 align="center">AstroNvim</h1>
A template for getting started with [AstroNvim](https://github.com/AstroNvim/AstroNvim)
<h4 align="center">
<a href="https://docs.astronvim.com/#-installation">Install</a>
·
<a href="https://docs.astronvim.com/#-configuration">Configure</a>
·
<a href="https://github.com/AstroNvim/astrocommunity">Community Plugins</a>
·
<a href="https://astronvim.com">Website</a>
·
<a href="https://discord.astronvim.com">Discord</a>
</h4>
<p align="center">
<a href="https://github.com/AstroNvim/AstroNvim/pulse">
<img src="https://img.shields.io/github/last-commit/AstroNvim/AstroNvim?style=for-the-badge&logo=github&color=7dc4e4&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/AstroNvim/AstroNvim/releases/latest">
<img src="https://img.shields.io/github/v/release/AstroNvim/AstroNvim?style=for-the-badge&logo=gitbook&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/AstroNvim/AstroNvim/stargazers">
<img src="https://img.shields.io/github/stars/AstroNvim/AstroNvim?style=for-the-badge&logo=apachespark&color=eed49f&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<img src="https://img.shields.io/endpoint?url=https://waka.mehalter.com/api/compat/shields/v1/mehalter/interval:any/label:AstroNvim&style=for-the-badge&label=wakatime&logo=wakatime&color=a6da95&logoColor=D9E0EE&labelColor=302D41"/>
<br>
<a href="https://www.twitter.com/AstroNvim">
<img src="https://img.shields.io/badge/@AstroNvim-e05d44?style=for-the-badge&logo=twitter&color=fab387&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://hachyderm.io/@AstroNvim">
<img src="https://img.shields.io/badge/@AstroNvim-e05d44?domain=https%3A%2F%2Fhachyderm.io&style=for-the-badge&logo=mastodon&color=eebebe&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://www.reddit.com/r/AstroNvim/">
<img src="https://img.shields.io/badge/%2Fr%2FAstroNvim-e05d44?style=for-the-badge&logo=reddit&color=ee99a0&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<br>
<a href="https://discord.astronvim.com">
<img src="https://img.shields.io/discord/939594913560031363?style=for-the-badge&logo=discord&color=cba6f7&logoColor=D9E0EE&labelColor=302D41"/>
</a>
</p>
<p align="center">
AstroNvim is an aesthetically pleasing and feature-rich neovim config that is extensible and easy to use with a great set of plugins
</p>
## 🌟 Preview
![Preview Image](https://astronvim.com/themes/overview.png)
## ✨ Features
- Common plugin specifications with [AstroCommunity](https://github.com/AstroNvim/astrocommunity)
- File explorer with [Neo-tree](https://github.com/nvim-neo-tree/neo-tree.nvim)
- Autocompletion with [Cmp](https://github.com/hrsh7th/nvim-cmp)
- Git integration with [Gitsigns](https://github.com/lewis6991/gitsigns.nvim)
- Statusline, Winbar, and Bufferline with [Heirline](https://github.com/rebelot/heirline.nvim)
- Terminal with [Toggleterm](https://github.com/akinsho/toggleterm.nvim)
- Fuzzy finding with [Telescope](https://github.com/nvim-telescope/telescope.nvim)
- Syntax highlighting with [Treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- Formatting and Linting with [None-ls](https://github.com/nvimtools/none-ls.nvim)
- Language Server Protocol with [Native LSP](https://github.com/neovim/nvim-lspconfig)
- Debug Adapter Protocol with [nvim-dap](https://github.com/mfussenegger/nvim-dap)
## ⚡ Requirements
- [Nerd Fonts](https://www.nerdfonts.com/font-downloads) (_Optional with manual intervention:_ See [Documentation on customizing icons](https://docs.astronvim.com/Recipes/icons)) <sup>[[1]](#1)</sup>
- [Neovim 0.9.1+ (_Not_ including nightly)](https://github.com/neovim/neovim/releases/tag/stable)
- [Tree-sitter CLI](https://github.com/tree-sitter/tree-sitter/blob/master/cli/README.md) (_Note:_ This is only necessary if you want to use `auto_install` feature with Treesitter)
- A clipboard tool is necessary for the integration with the system clipboard (see [`:help clipboard-tool`](https://neovim.io/doc/user/provider.html#clipboard-tool) for supported solutions)
- Terminal with true color support (for the default theme, otherwise it is dependent on the theme you are using) <sup>[[2]](#2)</sup>
- Optional Requirements:
- [ripgrep](https://github.com/BurntSushi/ripgrep) - live grep telescope search (`<leader>fw`)
- [lazygit](https://github.com/jesseduffield/lazygit) - git ui toggle terminal (`<leader>tl` or `<leader>gg`)
- [go DiskUsage()](https://github.com/dundee/gdu) - disk usage toggle terminal (`<leader>tu`)
- [bottom](https://github.com/ClementTsang/bottom) - process viewer toggle terminal (`<leader>tt`)
- [Python](https://www.python.org/) - python repl toggle terminal (`<leader>tp`)
- [Node](https://nodejs.org/en/) - node repl toggle terminal (`<leader>tn`)
> [!NOTE]
> <sup id="1">[1]</sup> All downloadable Nerd Fonts contain icons which are used by AstroNvim. Install the Nerd Font of your choice to your system and in your terminal emulator settings, set its font face to that Nerd Font. If you are using AstroNvim on a remote system via SSH, you do not need to install the font on the remote system.
> [!NOTE]
> <sup id="2">[2]</sup> Note when using default theme: For MacOS, the default terminal does not have true color support. You will need to use [iTerm2](https://iterm2.com/), [Kitty](https://sw.kovidgoyal.net/kitty/), [WezTerm](https://wezfurlong.org/wezterm/), or another [terminal emulator](https://gist.github.com/XVilka/8346728#terminal-emulators) that has true color support.
## 🛠️ Installation
AstroNvim is provided as a plugin that can be installed with the [`lazy.nvim`](https://github.com/folke/lazy.nvim) plugin manager and then used to import all of the plugin configurations that AstroNvim provides. To quickly get started it is recommended to start with the official [AstroNvim Template](https://github.com/AstroNvim/template) which provides a great starting point for a new AstroNvim based configuration.
### Linux/Mac OS (Unix)
#### Make a backup of your current nvim and shared folder
```shell
@ -15,20 +101,126 @@ mv ~/.local/state/nvim ~/.local/state/nvim.bak
mv ~/.cache/nvim ~/.cache/nvim.bak
```
#### Create a new user repository from this template
#### Clone the template repository
Press the "Use this template" button above to create a new repository to store your user configuration.
```shell
git clone --depth 1 https://github.com/AstroNvim/template ~/.config/nvim
rm -rf ~/.config/nvim/.git
nvim
```
You can also just clone this repository directly if you do not want to track your user configuration in GitHub.
#### Clone this repo with edit permissions
```shell
git clone --depth 1 ssh://git@git.linuxhg.com:2222/john-okeefe/AstroNvim.git ~/.config/nvim
nvim
```
### Windows (Powershell)
#### Make a backup of your current nvim and nvim-data folder
```pwsh
Rename-Item -Path $env:LOCALAPPDATA\nvim -NewName $env:LOCALAPPDATA\nvim.bak
Rename-Item -Path $env:LOCALAPPDATA\nvim-data -NewName $env:LOCALAPPDATA\nvim-data.bak
```
#### Clone the repository
```shell
git clone https://github.com/<your_user>/<your_repository> ~/.config/nvim
```
#### Start Neovim
```shell
```pwsh
git clone --depth 1 https://github.com/AstroNvim/template $env:LOCALAPPDATA\nvim
Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force
nvim
```
#### Clone this repo with edit permissions
```pwsh
git clone --depth 1 ssh://git@git.linuxhg.com:2222/john-okeefe/AstroNvim.git $env:LOCALAPPDATA\nvim
nvim
```
#### Minimal `~/.config/nvim/init.lua`
Some user's might not want to use an entire template or do any customization. Here is a minimal `~/.config/nvim/init.lua` file that simply set's up a base AstroNvim installation:
```lua
local lazypath = vim.fn.stdpath "data" .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
-- stylua: ignore
vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", "--branch=stable", lazypath })
end
vim.opt.rtp:prepend(lazypath)
require("lazy").setup { "AstroNvim/AstroNvim", version = "^4", import = "astronvim.plugins" }
```
## 📦 Basic Setup
#### Install LSP
Enter `:LspInstall` followed by the name of the server you want to install<br>
Example: `:LspInstall pyright`
#### Install language parser
Enter `:TSInstall` followed by the name of the language you want to install<br>
Example: `:TSInstall python`
#### Install Debugger
Enter `:DapInstall` followed by the name of the debugger you want to install<br>
Example: `:DapInstall python`
#### Manage plugins
Run `:Lazy check` to check for plugin updates
Run `:Lazy update` to apply any pending plugin updates
Run `:Lazy clean` to remove any disabled or unused plugins
Run `:Lazy sync` to update and clean plugins
#### Update AstroNvim
Run `:AstroUpdate` to get the latest updates from the repository<br>
#### Update AstroNvim Packages
Run `:AstroUpdatePackages` (`<leader>pa`) to update both Neovim plugins and Mason packages
## 🗒️ Links
- [AstroNvim Website](https://astronvim.com)
- [AstroNvim Documentation](https://docs.astronvim.com)
- [Setup](https://docs.astronvim.com/#-setup) is given for basic editor setup after installation
- [Default Mappings](https://docs.astronvim.com/mappings) more about the default key bindings
- [Customizing Plugins](https://docs.astronvim.com/configuration/customizing_plugins/) more about configuring and adding plugins
### 📹 Videos
There have been some great review videos released by members of the community! Here are a few:
- [Neovim With AstroNvim | Your New Advanced Development Editor](https://www.youtube.com/watch?v=GEHPiZ10gOk) (Version: 3, Content By: [@Cretezy](https://github.com/Cretezy))
- [Why I'm quitting VIM by Carlos Mafla](https://www.youtube.com/watch?v=71GDopdc9rw) (Version: 2, Content By: [@gigo6000](https://github.com/gigo6000))
- [Astro Vim - All in one Nvim config!! by John McBride](https://www.youtube.com/watch?v=JQLZ7NJRTEo) (Version: 1, Content By: [@jpmcb](https://github.com/jpmcb))
## 🚀 Contributing
If you plan to contribute, please check the [contribution guidelines](https://github.com/AstroNvim/.github/blob/main/CONTRIBUTING.md) first.
## ⭐ Credits
Sincere appreciation to the following repositories, plugin authors and the entire neovim community out there that made the development of AstroNvim possible.
- [Plugins](https://docs.astronvim.com/reference/default_plugins/)
- [NvChad](https://github.com/NvChad/NvChad)
- [LunarVim](https://github.com/LunarVim)
- [CosmicVim](https://github.com/CosmicNvim/CosmicNvim)
<div align="center" id="madewithlua">
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)](https://lua.org)
</div>