github-mirror/oh-my-fish
github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2025-03-15 17:16:20 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: add a section documenting dotfiles usage

Browse Source
This commit is contained in:
Derek Stavis 2015-08-30 01:40:15 -03:00
parent ce8b0d9df9
commit 135707b3d1
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -124,6 +124,7 @@ Uninstall Oh My Fish. See [uninstall](#uninstall) for more information.
# :triangular_flag_on_post: Advanced
+ [Startup](#startup)
+ [Dotfiles](#dotfiles)
+ [Core Library](#core-library)
+ [Packages](#packages)
+ [Creating](#creating)
@ -138,6 +139,18 @@ This script runs each time a new session begins, autoloading packages, themes an
The _config_ path (`~/.config/omf` by default) is defined by `$OMF_CONFIG` in `~/.config/fish/config.fish`. Modify this to load your own configuration, if you have any, as discussed in the [FAQ](FAQ.md#what-does-oh-my-fish-do-exactly).
## 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:
- __`theme`__ - The current theme
- __`bundle`__ - List of currently installed packages/themes
### About the bundle
Everytime a package/theme is installed or removed the `bundle` file is updated. You can also edit it manually and run `omf install` afterwards to satisfy the changes. Please note that while packages/themes added to the bundle gets automagically installed, a package/theme removed from bundle isn't removed from user installation.
## Core Library
The core library is a minimum set of basic utility functions that extend your shell.