summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Stankiewicz <sheerun@sher.pl>2020-10-19 02:34:23 +0200
committerAdam Stankiewicz <sheerun@sher.pl>2020-10-19 02:34:23 +0200
commit71d9a2db9f0c2f8db0b7396b1b9d347e29214440 (patch)
treea6580cc0a4e94b8b8a6db9ac1462a620b64701ca
parent233a817f05ba73574539ed7395bde49d183a807a (diff)
downloadvim-polyglot-71d9a2db9f0c2f8db0b7396b1b9d347e29214440.tar.gz
vim-polyglot-71d9a2db9f0c2f8db0b7396b1b9d347e29214440.zip
Add docs about sensible
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9daa1461..3c5fa337 100644
--- a/README.md
+++ b/README.md
@@ -8,11 +8,10 @@ A collection of language packs for Vim.
- It **won't affect your startup time**, as scripts are loaded only on demand\*.
- It **installs and updates 120+ times faster** than the <!--Package Count-->598<!--/Package Count--> packages it consists of.
-- It is more secure because scripts loaded for all extensions are generated by vim-polyglot (ftdetect).
-- Solid syntax and indentation support (other features skipped). Only the best language packs.
-- All unnecessary files are ignored (like enormous documentation from php support).
-- Automatically detect indentation (includes performance-optimized version of [vim-sleuth](https://github.com/tpope/vim-sleuth))
-- Each build is tested by automated vimrunner script on CI. See `spec` directory.
+- It is also more secure (scripts loaded for every filetype are generated by vim-polyglot)
+- Best syntax and indentation support (no other features). Hand-selected language packs.
+- Automatically detects indentation (includes fixed and performance-optimized version of [vim-sleuth](https://github.com/tpope/vim-sleuth), can be disabled)
+- Includes defaults from [vim-sensible](https://github.com/tpope/vim-sensible), which are usually necessary for editing in any language (can be disabled)
\*To be completely honest, optimized `ftdetect` script takes around `10ms` to load.
@@ -226,12 +225,23 @@ let g:polyglot_disabled = ['markdown.plugin']
Please note that disabling a language won't make in your vim startup any faster / slower (only for specific this specific filetype). All plugins are lazily loaded only when they are really needed.
+## Autoindent
+
Vim Polyglot tries to automatically detect indentation settings (just like vim-sleuth). If this feature is not working for you for some reason, please file an issue and disable it temporarily with:
```vim
let g:polyglot_disabled = ['autoindent']
```
+## Default settings
+
+Vim Polyglot includes vim-sensible plugin, which is usually necessary for editing any language. This can be disabled with:
+
+
+```vim
+let g:polyglot_disabled = ['sensible']
+```
+
## Contributing
Language packs are periodically updated using automated `scripts/build` script.