docs: add README with basic instructions
This commit is contained in:
		
							
								
								
									
										30
									
								
								.github/README.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										30
									
								
								.github/README.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,30 @@
 | 
				
			|||||||
 | 
					# AstroNvim Structured User Example
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					A user configuration template for [AstroNvim](https://github.com/AstroNvim/AstroNvim)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 🛠️ Installation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Make a backup of your current nvim and shared folder
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
 | 
					mv ~/.config/nvim ~/.config/nvim.bak
 | 
				
			||||||
 | 
					mv ~/.local/share/nvim ~/.local/share/nvim.bak
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Clone AstroNvim
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
 | 
					git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Clone the repository
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
 | 
					git clone https://github.com/AstroNvim/split_user_example ~/.config/nvim/lua/user
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Start Neovim
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
 | 
					nvim
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
		Reference in New Issue
	
	Block a user