Archives/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish synced 2024-11-03 15:40:32 +00:00
Code Issues Projects Releases Wiki Activity

README: add custom config file documentation

Browse Source 
Addresses #40 by briefly documenting init.fish file.
This commit is contained in:
Derek Willian Stavis 2015-09-27 01:15:49 -03:00
parent ca05effd55
commit 1be472aa86
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -101,10 +101,13 @@ Everytime you open a new shell the startup code initializes Oh My Fish installat
## Dotfiles
The `$OMF_CONFIG` directory represents the user state of Oh My Fish, and is the perfect
candidate for being added to your dotfiles and/or checked out to version control. There are two important files:
candidate for being added to your dotfiles and/or checked out to version control. There are three important files:
- __`theme`__ - The current theme
- __`bundle`__ - List of currently installed packages/themes
- __`init.fish`__ - Custom script sourced at shell start
It's highly recommended that your custom startup commands go into `init.fish` file instead of `~/.config/fish/config.fish`, as this allows you to keep the whole `$OMF_CONFIG` directory under version control.
### About the bundle