Skip to content

Commit 839dcf2

Browse files
committed
Update the readme content.
1 parent eafcee7 commit 839dcf2

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,43 @@
1-
# Sublime-Erlang
1+
# Erl-AutoCompletion
2+
3+
This plugin only supports Sublime Text 3.
24

35
Installation
46
------------
57

8+
#### with [Sublime Package Control](http://wbond.net/sublime_packages/package_control)
9+
10+
1. Open command pallet (default: `ctrl+shift+p`)
11+
2. Type `package control install` and select command `Package Control: Install Package`
12+
3. Type `Erl-AutoCompletion` and select `Erl-AutoCompletion`
13+
14+
Additional info about to use Sublime Package Control you can find here: [http://wbond.net/sublime_packages/package_control/usage](http://wbond.net/sublime_packages/package_control/usage).
15+
616
#### with Git
717

8-
cd ~/.config/sublime-text/Packages/ (open by: Preferences->Browse Packages)
9-
git clone https://github.com/lintingbin2009/Sublime-Erlang
18+
cd ~/.config/sublime-text/Packages/ (open by: Preferences -> Browse Packages)
19+
git clone https://github.com/lintingbin2009/Erl-AutoCompletion
1020
restart sublime-text
1121

1222
Requirement
1323
--------
1424

15-
Need to install Erlang. If Erlang is not installed, Sublime-Erlang will not be able to create an auto completion and goto definition index based on the version of Erlang you have installed.
25+
Need to install Erlang. If Erlang is not installed, Erl-AutoCompletion will not be able to create an auto completion and goto definition index based on the version of Erlang you have installed.
1626

1727
Settings
1828
--------
1929

20-
Settings file open by: Preferences -> Package Settings -> Sublime-Erlang
30+
Settings file open by: Preferences -> Package Settings -> Erl-AutoCompletion
2131

2232
#### escript settings
2333

2434
If you have set the escript environment variable, you do not need to set the escript value in the configuration file, comment it out.
2535

2636
#### erlang_project_folder settings
2737

28-
This configuration item is used to set the folder where you want to add the source code for the auto completion function.
38+
This configuration item is used to set the folder where you want to add the source code for the auto completion and goto definition function.
2939

30-
If you comment out this configuration, you will read all the files that have been opened by Sublime as the value for this configuration item.
40+
If you comment out this configuration(default), the plugin will read all the files that have been opened by Sublime as the value for this configuration item.
3141

3242
#### Autocomplete on ":"
3343

@@ -40,6 +50,10 @@ Sublime User or Erlang preferences:
4050
"auto_complete_triggers": [{"selector": "source.erlang", "characters": ":"}],
4151
}
4252

53+
#### Goto definition
54+
55+
The right mouse button can bring up the goto definition menu.
56+
4357
Discussing
4458
----
4559
- [Submit issue](https://github.com/lintingbin2009/Erl-AutoCompletion/issues)

sublime_erlang.sublime-settings

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// if escript not in the path, we need set escript path.
33
// "escript" : "D:\\erl8.3\\erts-8.3\\bin\\escript",
44

5-
"sublime_erlang_version" : "1.0.2",
5+
"sublime_erlang_version" : "1.0.3",
66

77
// "erlang_project_folder" : []
88
}

0 commit comments

Comments
 (0)