Skip to content

Commit

Permalink
Updating README with customizations text
Browse files Browse the repository at this point in the history
  • Loading branch information
Marius Mathiesen committed Jul 8, 2010
1 parent c4b7a02 commit ab08614
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.textile
Expand Up @@ -29,3 +29,15 @@ h2. Installation
git pull github master

Go into ~/.config/fish and add this repository, then pull. This will add the scripts in this projects for you to use.

h2. Customization

Since this repository is intended to replace your ~/.config/fish directory, you should keep your local customizations local - since they are probably of little use to other users.

The package provides some files you may customize:

* ~/.config/fish/(username).fish: Here you can place custom settings for your current user. This file will be loaded when you start fish
* ~/.config/fish/(machine name).fish: If you use the same repository on several machines, you may place custom settings for each machine in this file. For instance, if you have two machines: foo and bar, foo.fish will be loaded on foo and bar.fish on bar.
* ~/.config/fish/(platform).fish: This file is version controlled and keeps platform specific functions. Feel free to contribute functions for your favorite OS here

If you contribute custom functions that you wish to share, please verify that these are not loaded on platforms that don't support them.

0 comments on commit ab08614

Please sign in to comment.