From 1be472aa864298aae8f70b202b95a95f7496f774 Mon Sep 17 00:00:00 2001 From: Derek Willian Stavis Date: Sun, 27 Sep 2015 01:15:49 -0300 Subject: [PATCH] README: add custom config file documentation Addresses #40 by briefly documenting init.fish file. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f79c594..1ff9fb5 100644 --- a/README.md +++ b/README.md @@ -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