Commit Graph

353 Commits

Author SHA1 Message Date
Andrew Cobby
d3758c3052 README enhancements (#1547)
* Reformat the heading (add logo, centered styling)

The HTML is supported in the VS Code Marketplace site too, and this is
layout is shamelessly stolen from the Chrome Debugger plugin:
https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome

* Normalize how we reference the real Vim plugins

This what their repos are named, and make our README look more
consistent.

* Remove reference to useCtrlKeys in features list

It's enabled by default, and so isn't really a feature.

* Bulk refactoring of README

* Re-arrange certain sections based on importance
* Promoted plugin info to it's own section
* Add contents
* Bunch of other small formatting tweaks

* Simply plugins point in features

They're outlined nicely in the contents area just below, seems like
overkill to have them all listed here too.

* Add Contents link to status bar customization (vim-airline)

* Push FAQ further down the page

The tricks list is cooler (read: more important)

* Additional language/linking tweaks

* Add 'json' language to code blocks

And clean up extra closing backticks

* Prefer "setting" over "option" or "configuration"

This is in-line with terminology in VSCode (i.e. `settings.json`).

* Fix heading numbers and use Sentence case

* Fix formatting and indentation issues

* Move Key remppaing under settings

And move `useCtrlKeys` and `handleKeys` into VSCodeVim Settings.

* Add OS-specific setup sub-sections

* More heading tweaks

* Add more links to useCtrlKeys and handleKeys

* Fix formatting with backticks

The stuff between the <...> was getting drop because Markdown parsers
think that it's HMTL tags ;)

* Fix typo

* More heading level and case fixes

* Add quick-link to `gc` docs

* Format VSCode Vim tricks list consistently

* Test: backticks around settings headings

* Make setting's headings map to JSON keys

* Fix Contents link to Emulated plugins

* Tweaks to Contributing and Release notes

* Tight up features some more

* Introduce "Getting started" section with OS-setup info

It didn't make sense to have Settings-related info here. The quick
example settings has been more to the start of the Settings section.

* Add sub-section on compatibility with link to ROADMAP

* Remove duplicate info about key repeat issues on Mac

* Tweak waffling

* Small grammar fix
2017-04-23 17:26:04 -07:00
Sean Kelly
c21c1f2e76 Merge branch 'master' into change-system-clipboard-library 2017-04-19 12:27:59 -07:00
xconverge
d80999a880 fix mistake in readme 2017-04-18 20:07:43 -07:00
xconverge
da8869ced1 update readme for status bar color changing 2017-04-18 20:06:23 -07:00
Erik J. Sturcke
aa5ac4fdee Fix README description for af 2017-04-17 23:10:28 -04:00
Sean Kelly
f009dca826 Update README 2017-04-16 10:00:04 -07:00
Sean Kelly
1d58dc05b3 Merge branch 'master' into add-vim-cmdline-to-remapper 2017-04-16 09:55:55 -07:00
Kim Fiedler Vestergaard
faa3d2a998 Add notes about commentary to README.md 2017-04-16 12:52:51 +02:00
xconverge
ddfdf58d1c update readme for remapping vim command line commands 2017-04-15 22:58:25 -07:00
Sean Kelly
f9ca98af41 Merge branch 'master' into change-system-clipboard-library 2017-04-11 14:20:35 -07:00
Edasaki
0281c4789e 1 last typo X_X 2017-04-11 11:16:20 -07:00
Edasaki
b6af3bc0e9 tweaked a bit of formatting 2017-04-11 11:14:40 -07:00
Edasaki
2845a4aa12 typo fix 2017-04-11 11:12:16 -07:00
Edasaki
41b354fdc5 readme update 2017-04-11 11:11:09 -07:00
xconverge
76001eced1 Add ability to turn surround plugin off 2017-04-10 19:23:59 -07:00
xconverge
da68c5f87b noticed clipboardy library has xsel binary embedded for linux already 2017-04-09 11:56:24 -07:00
xconverge
97e016d186 change system clipboard library to a newer more maintained library to try and resolve UTF-8 and chinese character issues 2017-04-09 11:50:07 -07:00
xconverge
f8fd591720 Put using custom background colors for easymotion behind a configuration option so that default behavior remains the same 2017-03-26 10:26:15 -07:00
Sean Kelly
008a4f4869 Merge branch 'master' into delegate-keys-config 2017-03-25 09:20:35 -07:00
xconverge
272f7826e2 Clarify readme entry slightly for vim.handleKey config option 2017-03-25 09:11:58 -07:00
Grant Mathews
f6a4c3272c Update README. I totally forgot about this little command! 2017-03-25 18:19:21 +07:00
xconverge
14a1e97b33 update readme for handleKeys config option 2017-03-24 22:48:06 -07:00
xconverge
e2ccd78423 update readme for plugins 2017-03-19 00:53:15 -07:00
Corey Farwell
8b31a48275 Fix comment syntax for shell commands.
If one attempts to copy and paste both of these lines, it'll complain about invalid comments
2017-03-18 10:08:53 -04:00
johnfn
700ec40d64 Add af, a custom command. Selecting blocks is fast af! 2017-03-18 15:20:50 +07:00
Sean Kelly
39ab72fa41 Update README.md 2017-03-11 18:49:46 -08:00
Grant Mathews
2405ee2612 Update README a little bit. 2017-03-03 18:23:52 +08:00
johnfn
a0a64232fc Override VSCode copy command. #1337, #616. 2017-02-28 08:22:35 +08:00
Sean Kelly
8bccd3c474 Update readme for some clarity on using settings (#1295)
* Update readme for some clarity on using settings

* Update README.md
2017-02-13 20:16:57 -08:00
Clint Ryan
682045f012 Fixes README spelling mistake 2017-01-25 13:24:44 +11:00
Grant Mathews
2060be3b0c Sneak in a donation image change 2017-01-23 23:38:35 +07:00
johnfn
c2569dcec2 Mention surround.vim in the README 2017-01-23 20:33:20 +07:00
Grant Mathews
eef0590bde Update README.md 2017-01-10 21:08:49 +07:00
Grant Mathews
4e9ccddf74 Update README.md 2017-01-10 12:17:50 +07:00
Grant Mathews
3eadfedfd9 Update README 2017-01-10 12:15:59 +07:00
Grant Mathews
701d01358e Fix link 2017-01-09 13:49:17 +07:00
Grant Mathews
58147d605c Add paypal link thing 2017-01-09 08:52:32 +07:00
Grant Mathews
d3f030c470 <3 2016-12-30 14:38:29 -05:00
Clinton Ryan
ca7bef095b Adds documentation for adding leader bindings (#1182) 2016-12-20 16:19:15 -05:00
Maxim Bonnaerens
d827e578a7 Updated useCtrlKeys default value (#1126) 2016-12-07 02:45:13 -05:00
Sean Kelly
b0bbf819b1 Update readme for easymotion (#1114) 2016-12-05 01:24:44 -05:00
johnfn
64a2752732 Add <leader> support. 2016-12-04 20:21:36 -05:00
johnfn
6bb5c4e8a5 Allow customizeable search highlight color. Fixes #1052 2016-12-04 20:16:01 -05:00
johnfn
16cdc99944 Add timeout for remapped commands. Fixes #396. 2016-12-04 17:25:57 -05:00
johnfn
6ef810b1b7 Add showcmd configuration setting. Closes #1109. 2016-12-04 14:19:30 -05:00
Grant Mathews
6f00e8e63f Update README.md 2016-12-04 13:33:00 -05:00
Grant Mathews
6c037ff9d1 Update README.md 2016-12-04 00:55:09 -05:00
Grant Mathews
6a42b0b6fd Update README with more examples 2016-12-03 23:50:07 -05:00
johnfn
c7ebb5536d Merge branch 'master' into gq
Conflicts:
	package.json
2016-12-03 19:54:51 -05:00
johnfn
7f0fbab2f7 Add textwidth configuration variable. 2016-12-03 19:50:43 -05:00
Grant Mathews
78bb04cf53 Update README.md 2016-12-01 15:35:07 -05:00
Grant Mathews
4d905bd072 Put snarky comment in README 2016-12-01 15:33:38 -05:00
johnfn
a0bec14564 Add startInInsertMode configuration option. 2016-12-01 15:31:33 -05:00
Grant Mathews
fdc7312707 Update README
How on earth did we forget to mention EasyMotion..?!?
2016-11-30 18:14:17 -05:00
johnfn
42537089a2 Update README 2016-11-29 13:44:01 -05:00
Grant Mathews
dc800c09cc Update README 2016-11-01 16:28:26 -07:00
Jason Poon
04f8887371 Update Readme. Attempt to make it more succint and add point about useCtrlKeys option in an attempt to avoid those questions on our Slack. (#1012) 2016-10-28 12:14:08 -07:00
Grant Mathews
28c3688817 Update README 2016-10-19 02:00:22 -07:00
Jason Poon
61f929a137 Update README.md 2016-10-07 17:54:57 -07:00
Grant Mathews
7c945f6217 Update README 2016-10-07 17:51:57 -07:00
johnfn
7dc26b24c9 Couple of minor changes. 2016-10-03 13:41:05 -07:00
johnfn
07d7d72d44 Add a new command + some documentation in the README. 2016-10-03 13:34:45 -07:00
Sean Kelly
42d3c99d74 -updated documentation, closes #809 (#813) 2016-10-01 11:12:15 -07:00
johnfn
2430e3f645 Merge branch 'master' into multi-cursor-mode-simple
Conflicts:
	src/register/register.ts
2016-09-30 15:12:09 -07:00
Jason Poon
e568fbda37 Fix Docs (#807)
Fix docs
2016-09-27 23:16:48 -07:00
Stephan Renatus
7ae1ff078e Add autoindent to README, fix hlsearch default
I believe [hlsearch is false by default](214619d8d6/src/configuration/configuration.ts (L56)).
2016-09-23 08:08:20 +02:00
johnfn
e8b393945c Minor text updates 2016-09-20 00:51:50 -07:00
Sean Kelly
cbe37e727e fixes #750 2016-09-10 13:48:58 -07:00
Jason Poon
9dab0f29ad Add a badge linking to the vs marketplace 2016-09-08 14:08:46 -07:00
Pine
817627863d Doc for enabling repeating j/k for Insider build (#733) 2016-09-07 21:48:33 -07:00
Jason Poon
3432258f54 Update README.md (#714)
Argh, fix some formatting issues.
2016-09-05 01:18:53 -07:00
Jason Poon
f3127d9c09 Add vim.* settings to readme. Fixes #503 (#713) 2016-09-05 00:59:57 -07:00
Jason Poon
73f4f6ee22 Use angle bracket notation replacing ctrl+* => <C-*>, backspace => <BS>, etc. Closes #64 (#683) 2016-08-31 21:09:50 -07:00
amin roosta
214619d8d6 implement useSystemClipboard command (#665) 2016-08-30 01:24:04 -07:00
Anton Aderum
45e7753376 Fix missleading readme instruction (#647) 2016-08-24 02:03:04 -07:00
Jason Poon
95afd14ccf Update README.md
Elaborate on how to execut `ApplePressAndHoldEnabled`
2016-08-18 14:20:43 +01:00
rebornix
edd234a842 enable ctrl+[ only when useCtrlKeys is turned on 2016-08-15 13:35:03 +08:00
Grant Mathews
cba507db79 Update README 2016-08-13 00:57:26 -07:00
rebornix
df7574f90b fix typo and comments 2016-08-12 21:28:05 +08:00
Grant Mathews
850b32523f Link to release list 2016-08-09 11:26:06 -07:00
Grant Mathews
398639e64f Update README 2016-08-09 03:16:42 -07:00
Grant Mathews
4e0bf31a25 Put ctrl-f into the README as well
I separated it from ctrl-c for readability and ctrl-f (heh, ironic) -ability.
2016-08-09 00:36:29 -07:00
Jim Ray
77fb6a5c22 OS X non-global key repeat fix (#577)
The current README has the user disable OS X’s “press and hold” feature at a global level. It’s possible to disable this on a per-app basis, though, provided you know the name of an app’s .plist file.

This change will disable “press and hold” only for VSCode, not globally.
2016-08-06 20:53:27 -07:00
johnfn
1b8308cda7 Update README to new escape key 2016-08-02 23:47:10 -07:00
Philip Jagielski
935efe6d8f Fix instructions for setting key bindings (#499) 2016-07-23 15:03:41 -06:00
Jason Poon
249b6d89f6 Update README.md 2016-07-21 15:30:43 -07:00
Grant Mathews
4807373719 Update README 2016-07-19 11:56:46 -06:00
Grant Mathews
2a8b46e839 Update README 2016-07-19 03:32:01 -06:00
Jason Poon
5a2bce3e39 Remove custom keyboard mapping (fixes #432). Fix duplicate definition errors 2016-07-14 12:38:42 -07:00
Grant Mathews
a1b9df71b8 Be even clearer, hopefully, about missing features. 2016-07-14 02:14:42 -07:00
Grant Mathews
7ab1cc36df Update README 2016-07-13 23:57:42 -07:00
Grant Mathews
f50c386b2c Update FAQ in README 2016-07-13 22:28:25 -07:00
Jason Poon
602b8cff75 Fix Roadmap Link 2016-07-07 18:03:48 -07:00
Frederick Fogerty
6c52ca56b3 Fix Roadmap link (#405) 2016-07-07 18:03:06 -07:00
Grant Mathews
491f86cc4e Update README 2016-07-07 00:42:42 -07:00
Grant Mathews
03a2dd9306 Incremental README editing too 2016-07-07 00:09:14 -07:00
Grant Mathews
02a266103e Make README more explicit 2016-07-07 00:08:37 -07:00
Grant Mathews
42a8da6fc0 Feature list 2016-07-06 23:59:05 -07:00
Grant Mathews
c6b42bf764 Stupid markdown numbering system 2016-07-04 10:06:25 -07:00
Grant Mathews
6c22df4d6f Update README 2016-07-04 10:05:53 -07:00
Jason Poon
789277f3c3 Update README.md
Fix links
2016-07-04 01:48:04 -07:00
Jason Poon
bc9258b664 Add issue, PR templates. Merge developing to contributing.md 2016-07-03 21:33:10 -07:00
Grant Mathews
027b7fd804 Update README 2016-06-23 11:35:47 -07:00
Grant Mathews
c2197cea94 Update README 2016-06-23 02:21:54 -07:00
Grant Mathews
919d350237 Update README 2016-06-23 01:53:28 -07:00
Jason Poon
cb0b2ff194 Update README.md
Dropping overriding keys cause it no longer works on latest version.
2016-06-22 00:44:31 -07:00
Grant Mathews
538bd766eb Update README 2016-06-05 12:00:32 -07:00
Pär Björklund
483b1144ec Add s keybinding 2016-06-05 18:23:11 +02:00
Jason Poon
3a37d15504 Refactor CommandKeyMap
* follow similar pattern to keyboardLayout
* all user configurations accessible through configuration class
* simplified the custom keyboard layout class
2016-05-20 23:32:42 +03:00
Jason Poon
ae125c33cb Update README.md 2016-05-19 04:53:49 -07:00
Jason Poon
244d8efd5f Update to new extension APIs. No longer requests binding to every single letter in package.json.
* Update outdated npm packages
* Update typings
* Fixes #157, #126, #188
* Remove appveyor builds as vscode doesn't support them as a CI
2016-05-19 02:59:16 -07:00
Linden Krouse
2b9b1548a1 Added basic support for rebinding keys. Support is limited but nothing should be changed for anything not related to rebinding keys using user configuration. Partial fix for #185 and #128. 2016-05-12 18:07:40 -04:00
Making GitHub Delicious
2ff26226d5 add waffle.io badge 2016-05-11 09:12:35 -06:00
Pieter Joost van de Sande
1e9331f636 Add check mark to D key in README
As implemented by f0b53887ee
2016-05-10 16:10:05 +02:00
Jason Poon
8383041003 Update README.md 2016-05-08 21:28:42 -07:00
Francisco Requena
b0eb363ec3 c commands and ge motions 2016-03-10 10:56:47 +01:00
Francisco Requena
f0b53887ee d{motion} support 2016-03-04 14:27:05 +01:00
Tienshiao Ma
2978dbe7c0 Add E (end of WORD), and fix up e (end of word). 2016-02-23 14:22:40 -08:00
Tienshiao Ma
f412ae1782 Move private methods and update readme 2016-02-18 11:46:59 -08:00
Jason Poon
2ae886d2bd Update README.md
Update appveyor instance
2016-02-16 12:35:00 -08:00
Jason Poon
6ae24ac68e Readme: fix typos 2016-01-06 15:59:32 -08:00
Jason Poon
02811b2bef update readme with table of commands 2016-01-06 15:54:18 -08:00
kedde
00aca14e2d added danish keyboard layout 2016-01-06 22:46:53 +01:00
Jason Poon
aca5d5c57d 0.0.7 - update docs 2016-01-03 00:31:33 -08:00
Jason Poon
ac9903283b Readme: update with keyboard configuration (compliments of guillermooo) 2016-01-02 02:30:29 -08:00
Jason Poon
b294158843 Update slackin link 2015-12-15 16:52:03 -08:00
Jason Poon
5ca95e3c3d readme: update to display appyveyor badge for master branch only 2015-12-06 01:14:14 -08:00
Jason Poon
737d73615c v0.0.3
* clean up readme and contribution
2015-12-04 14:04:42 -08:00
Jason Poon
d1be37c412 move setup stuff to contributing.md 2015-12-02 21:03:22 -08:00
Jason Poon
13ff3bcac9 readme: set code syntax highlighting to bash 2015-12-02 02:18:16 -08:00
Jason Poon
9db9fa3bde Merge pull request #80 from VSCodeVim/update-readme
readme: update more detailed contributing info
2015-12-02 02:12:38 -08:00
Jason Poon
01c7ef7474 readme: update more detailed contributing info 2015-12-02 02:10:50 -08:00
Shuping LIU
90879b7e77 Add commands support for 'gg': go to first line, on first non-blank character; 'G': go to last line, on first non-blank character 2015-12-02 17:35:08 +08:00
Jason Poon
455f957ee5 readme: accidentally a word 2015-11-30 14:18:57 -08:00
Jason Poon
e913d28827 Update readme to use 'gulp init' instead of 'tsd' directly 2015-11-30 10:54:41 -08:00
Mark Rendle
5c1218785b Update README.md
Added step to run tsd install to Contributing section.
2015-11-30 10:31:14 +00:00
Jason Poon
ba61086b0d add contributing info to readme 2015-11-29 17:44:19 -08:00
Jason Poon
158bbaa820 implement A to insert EOL. Release v0.0.2 2015-11-29 09:43:41 -08:00
Jason Poon
b28df21fc0 remove coming soon tag from readme 2015-11-29 02:44:26 -08:00
Jason Poon
c7f9490d4e fix package in order to publish 2015-11-29 02:37:35 -08:00
Jason Poon
ac66853677 implement redo 2015-11-29 00:41:08 -08:00
Jason Poon
8e97043780 Update metadata getting ready for a release 2015-11-26 12:37:52 -08:00
Jason Poon
b02759c037 add slackin link 2015-11-25 00:25:05 -08:00
guillermooo
3e151bfb16 edit readme 2015-11-19 19:23:13 +01:00
guillermooo
206ab01adb edit readme 2015-11-19 19:22:17 +01:00
guillermooo
32c1cfd9b4 edit readme 2015-11-19 19:20:50 +01:00
Jason Poon
7e5b6693ed Update README.md 2015-11-18 13:50:37 -08:00
Jason Poon
636bb301d9 Update README.md 2015-11-18 12:09:52 -08:00
Jason Poon
1b45084c0b Update README.md 2015-11-18 12:00:58 -08:00
Jason Poon
49fbf7600b update readme 2015-11-16 22:39:04 -08:00
guillermooo
68047e28cd edit README 2015-11-12 21:14:24 +01:00
guillermooo
e46dcd28b5 edit README 2015-11-12 21:13:38 +01:00
guillermooo
6652b63929 scaffold project 2015-11-12 20:51:40 +01:00