Skip to content
100644 31 lines (20 sloc) 1.32 KB
fbfcc63 @igrigorik link header in readme
igrigorik authored
1 # []( Client
3fcf1e7 @igrigorik add readme
igrigorik authored
3 Real Vim ninjas count every keystroke - do you? Head on over to, pick a challenge, and show us what you've got! The rules are simple:
5 * Each challenge provides an input file, and an output file
6 * Your goal is to modify the input file such that it matches the output
7 * Once you install the vimgolf CLI, pick a challenge, open a prompt and put away!
9 When you launch a challenge from the command line, it will be downloaded from the site and a local Vim session will be launched, which will log every keystroke you make. Once you're done, simply *:wq* (write and quit) the session and we will score your input and upload it back to the site!
11 Let the games begin.
13 ## Setup & Play
15 <pre>
16 1. $> gem install vimgolf
17 2. $> vimgolf setup (go to, sign in, and grab your API key)
18 3. Pick a challenge on
19 4. $> vimgolf put [challenge ID]
20 </pre>
22 ## Todo's & Wishlist
24 * At the moment, scoring is done based on the simplest possible model: bytesize of your Vim script file. Instead, we'd like to assign a score based on shortcuts and key-combinations used. Ex: visual mode gets you extra x points, etc.
25 * Vim script parser - distinguish between different modes, keystrokes, etc.
27 Other patches, tips & ideas are welcome!
29 ## License
31 (MIT License) - Copyright (c) 2010 Ilya Grigorik
Something went wrong with that request. Please try again.