summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Stankiewicz <sheerun@sher.pl>2016-06-28 16:05:24 +0200
committerGitHub <noreply@github.com>2016-06-28 16:05:24 +0200
commita5857b81c215139b3c0def78e5bd2f1da8a17af6 (patch)
tree21e7f03d4fdcf6d3f4078d0d4738ef8a9f80bb18
parent7a32eec6d17ec6de269753b8ef7b11d27b562853 (diff)
downloadvim-polyglot-a5857b81c215139b3c0def78e5bd2f1da8a17af6.tar.gz
vim-polyglot-a5857b81c215139b3c0def78e5bd2f1da8a17af6.zip
Create troubleshooting section in the README
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index b8e93730..1fa21a3d 100644
--- a/README.md
+++ b/README.md
@@ -112,9 +112,15 @@ Optionally download one of the [releases](https://github.com/sheerun/vim-polyglo
- [yaml](https://github.com/stephpy/vim-yaml) (syntax, ftplugin)
- [yard](https://github.com/sheerun/vim-yardoc) (syntax)
-## Disabling a language pack
+## Updating
+
+You can either wait for new patch release with updates or run the `./build` script by yourself.
+
+## Troubleshooting
+
+Please make sure you have `syntax on` in your `.vimrc`, otherwise syntax files are not loaded at all.
-Individual language packs can be disabled by setting `g:polyglot_disabled`.
+Individual language packs can be disabled by setting `g:polyglot_disabled` as follows:
```viml
" ~/.vimrc
@@ -123,10 +129,6 @@ let g:polyglot_disabled = ['css']
Note that disabiling languages won't make in general your vim startup any faster / slower (only for specific file type). Vim-polyglot is selection of language plugins that are loaded only on demand.
-## Updating
-
-You can either wait for new patch release with updates or run the `./build` script by yourself.
-
## Contributing
Language packs are periodically updated using automated `build` script.