mirror of
				https://gitlab.com/ceda_ei/wish
				synced 2025-10-31 09:20:05 +01:00 
			
		
		
		
	Update README
This commit is contained in:
		
							
								
								
									
										36
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										36
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,3 +1,37 @@ | ||||
| # Wish | ||||
|  | ||||
| A customizable bash prompt. | ||||
| A customizable bash prompt. | ||||
|  | ||||
| # Installation | ||||
|  | ||||
| ## One step Installation | ||||
|  | ||||
| `curl https://gitlab.com/ceda_ei/wish/raw/master/install.sh | bash` | ||||
|  | ||||
| ## Manual Installation | ||||
|  | ||||
| + `cd ~/.config/` | ||||
| + `git clone https://gitlab.com/ceda_ei/wish.git` | ||||
| + Add the following lines to ~/.bashrc | ||||
|  | ||||
| ``` | ||||
| WISH_PLUGINS=(exit_code_smiley bg_jobs date path newline vcs) | ||||
| WISH_THEME=plain | ||||
| source ~/.config/wish/wish.sh | ||||
| ``` | ||||
|  | ||||
| # Customization | ||||
|  | ||||
| + To change the order of plugins, edit the `WISH_PLUGINS` array. | ||||
| + To change the theme, edit the `WISH_THEME` variable. | ||||
| + To enable/disable powerline fonts, set `WISH_POWERLINE` to `1` or `0`. | ||||
|  | ||||
| ## Example config | ||||
|  | ||||
|  | ||||
| ``` | ||||
| WISH_DATE_FORMAT="%d %b %H:%M" # Look in date plugin for details | ||||
| WISH_PLUGINS=(newline exit_code bg_jobs tmux date battery path python_venv newline vcs space) | ||||
| WISH_POWERLINE=1 | ||||
| WISH_THEME=rgb_gradient | ||||
| ``` | ||||
|   | ||||
							
								
								
									
										
											BIN
										
									
								
								screenshots/example_config.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								screenshots/example_config.png
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 19 KiB | 
		Reference in New Issue
	
	Block a user