Skip to content

Commit

Permalink
Improve README.
Browse files Browse the repository at this point in the history
  • Loading branch information
edelvalle committed May 17, 2017
1 parent 08d20bf commit f1ed407
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Default.sublime-mousemap
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[
{
"modifiers": ["ctrl"], "button": "button2",
"command": "super_elixir_goto",
"press_command": "drag_select",
}
// {
// "modifiers": ["ctrl"], "button": "button1",
// "command": "super_elixir_goto",
// "press_command": "drag_select",
// }
]
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,76 @@ Additional info installations you can find here [http://wbond.net/sublime_packag

Make sure you have at least Elixir 2.4.4 installed.

### Elixir interpreter settings

By default this package will use default Elixir interpreter from the `PATH`.
Also you can set different interpreter for each Sublime Project.

To set project related Elixir interpreter you have to edit yours project config file.
By default project config name is `<project name>.sublime-project`

You can set Elixir interpreter, using for example the following:

# <project name>.sublime-project
{
// ...

"settings": {
// ...
"elixir_interpreter": "~/elixir-2.4.4/bin/elixir",
}
}

### Autocomplete on DOT

If you want auto-completion on dot, you can define a trigger in the
Sublime User or Python preferences:

# User/Preferences.sublime-settings or User/Elixir.sublime-settings
{
// ...
"auto_complete_triggers": [{"selector": "source.elixir", "characters": "."}],
}

If you want auto-completion **ONLY** on dot and not while typing, you can
set (additionally to the trigger above):


# User/Preferences.sublime-settings or User/Elixir.sublime-settings
{
// ...
"auto_complete_selector": "-",
}

### Go to definition

Find function / variable / module definition / anything else.

Shortcuts: `CTRL+SHIFT+G`

Mouse binding, was disabled, because sublime does not allows to set a scope so is active just in Elixir source files, and this can interfere with the global SublimeText configuration. But, if you want to use your mouse you can bind `CTRL + LeftMouseButton`:

# User/Default.sublime-mousemap
[
{
"modifiers": ["ctrl"], "button": "button1",
"command": "super_elixir_goto",
"press_command": "drag_select",
}
]


### Code navigation

As Elixir code is structured as a set of hierarchical modules this feature lists all loaded modules and allows you to select one of them an go to it.

Shortcuts: `CTRL+SHIFT+L`

#### Show types and documentation

Just put your mouse on top of the term and you want documentation about. If it is a function it will list types first and then the documentation. It is not very pretty, we are working on it.


## Special thanks

- Elixir Sense: provides the Elixir introspection capabilities.
Expand Down

0 comments on commit f1ed407

Please sign in to comment.