Skip to content

Commit

Permalink
add install.md
Browse files Browse the repository at this point in the history
  • Loading branch information
niosus committed May 22, 2016
1 parent f6dce7a commit f41614e
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 24 deletions.
23 changes: 0 additions & 23 deletions easy_auto_complete.sublime-project

This file was deleted.

2 changes: 1 addition & 1 deletion messages.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"install": "README.md",
"install": "messages/install.md",
"1.0.1": "messages/st3-1.0.1.md",
"1.0.2": "messages/st3-1.0.2.md",
"1.0.3": "messages/st3-1.0.3.md",
Expand Down
28 changes: 28 additions & 0 deletions messages/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Sublime Text 3 plugin that offers clang-based auto-completion for C++

This plugin aims to provide easy-to-use, minimal-setup autocompletions for C++
for Sublime Text 3. It is built to function in an asynchronous way, so that you
will not have to wait even when completions take slightly longer to load.

The plugin uses `libclang` with its python bindings to provide clang-based
autocompletions. In case `libclang` cannot be initialized or found it will use
completions based on the output of `clang -code-completion-at` run from the
command line.

If you want this as default behavior, set the setting `use_libclang` to
`false`.

This plugin is intended to be easy to use. It should autocomplete STL out of
the box and you should just add the folders your project uses to `include_dirs`
list in the settings to make it autocomplete code all your project. If you
experience problems - create an issue. I will try to respond as soon as
possible.


## IMPORTANT ##
Please be sure to read through the readme installation section to
make everything working here:
https://github.com/niosus/EasyClangComplete/blob/master/README.md#how-to-install

You can find all the relevant settings you can set here:
https://github.com/niosus/EasyClangComplete/blob/master/README.md#settings-highlights

0 comments on commit f41614e

Please sign in to comment.