From f41614ecdb73ad938eab000e697598097d6428bc Mon Sep 17 00:00:00 2001 From: Igor Bogoslavskyi Date: Sun, 22 May 2016 08:59:15 +0200 Subject: [PATCH] add install.md --- easy_auto_complete.sublime-project | 23 ----------------------- messages.json | 2 +- messages/install.md | 28 ++++++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 24 deletions(-) delete mode 100644 easy_auto_complete.sublime-project create mode 100644 messages/install.md diff --git a/easy_auto_complete.sublime-project b/easy_auto_complete.sublime-project deleted file mode 100644 index 1a062972..00000000 --- a/easy_auto_complete.sublime-project +++ /dev/null @@ -1,23 +0,0 @@ -{ - "build_systems": - [ - { - "file_regex": "^[ ]*File \"(...*?)\", line ([0-9]*)", - "name": "Anaconda Python Builder", - "selector": "source.python", - "shell_cmd": "\"python\" -u \"$file\"" - } - ], - "folders": - [ - { - "path": "." - } - ], - "settings": - { - "FuzzyFilePath": - { - } - } -} diff --git a/messages.json b/messages.json index 0567d701..cc87ca0f 100644 --- a/messages.json +++ b/messages.json @@ -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", diff --git a/messages/install.md b/messages/install.md new file mode 100644 index 00000000..3388c45d --- /dev/null +++ b/messages/install.md @@ -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 \ No newline at end of file