Skip to content

Commit

Permalink
Add documentation about 'start_directory' setting and update others a…
Browse files Browse the repository at this point in the history
…s well
  • Loading branch information
hmml committed Jan 2, 2014
1 parent e7f33b4 commit 83f8e73
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Expand Up @@ -31,19 +31,21 @@ There are a few notable options:
Configuration
-------------

Default configuration is stored in `SublimeFiles.sublime-settings` accessible from _Preferences->Package Settings->Sublime Files->Settings - Default_. When changing any of the settings below it's suggested to use the user settings: _Preferences->Package Settings->Sublime Files->Settings - User_ as the file will remain untouched when updating plugin.

__Ignore file types__

SublimeFiles by default will ignore `*.pyc` files and `*.class` files. You can modify the list of ignored files by changing the `ignore_list` in `SublimeFiles.sublime-settings` (Preferences->Package Settings->Sublime Files->Settings - Default). For example:
Sublime Files by default will ignore `*.pyc` files and `*.class` files. You can modify the list of ignored files by changing the `ignore_list`. For example:

{
"ignore_list": ["*.pyc", "*.class", "*.o"]
}

__Open Terminal__

For OS X/Linux systems, Sublime Files can open up a terminal at the current directory navigated to. In order for this feature to work properly, you will have to modify the `term_command` field in the `SublimeFiles.sublime-settings` file (Preferences->Package Settings->Sublime Files->Settings - Default). As a default, it is set to open up Terminal.app for OS X systems.
For OS X/Linux systems, Sublime Files can open up a terminal at the current directory navigated to. In order for this feature to work properly, you will have to modify the `term_command`. As a default, it is set to open up Terminal.app for OS X systems.

For example, Gnome Terminal and iTerm2 users respectively will want to change term\_command in `SublimeFiles.sublime-settings` to:
For example, Gnome Terminal and iTerm2 users respectively will want to change `term_command` to:

{
"term_command": "gnome-terminal --working-directory="
Expand All @@ -54,3 +56,13 @@ and
{
"term_command" : "open -a iTerm\ 2 "
}

__Start directory__

If you _always_ want to start navigation from a given directory for example `~` just update the `start_directory` setting:

{
"start_directory": "~"
}

Default configuration comes with this setting turned off (set to `null`).

0 comments on commit 83f8e73

Please sign in to comment.