Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add a README

  • Loading branch information...
commit 5966bb5d8d42c8eeced7feeb90903cad7437e49b 1 parent 734e410
@tpope authored
Showing with 71 additions and 0 deletions.
  1. +71 −0 README.markdown
View
71 README.markdown
@@ -0,0 +1,71 @@
+# speeddating.vim
+
+Take the following date:
+
+ 1999-12-31
+
+Because Vim treats the hyphen as a negative sign, pressing `<C-A>` on the 31
+would normally increment it to
+
+ 1999-12-30
+
+Compare this with what happens when speeddating.vim is installed:
+
+ 2000-01-01
+
+Pressing `5<C-X>` on the `03` in the first line below transforms it into the
+second:
+
+ Sat, 01 Jan 2000 00:00:03 +0000
+ Fri, 31 Dec 1999 23:59:58 +0000
+
+Several date, time, and datetime formats are included. Additional formats can
+be defined in a strftime-like syntax with the `:SpeedDatingFormat` command.
+
+Existing Vim semantics are preserved. `<C-A>` and `<C-X>` accept a count, and
+plain number incrementing is used if no date format is matched.
+
+Use of `<C-A>`/`<C-X>` in visual mode enables incrementing several lines at
+once. Blank spots are filled by incrementing the match from the previous
+line, allowing for creation of sequences (1, 2, 3; 2000-10-30, 2000-10-31,
+2000-11-01).
+
+It can also increment roman numerals and ordinals (1st, 2nd, 3rd, ...). In
+visual mode, letters of the alphabet are supported.
+
+`d<C-A>` sets the timestamp under the cursor to the current time. `d<C-X>`
+does the same, but uses UTC rather than the local time.
+
+The `.` command will work as expected if you install
+[repeat.vim](https://github.com/tpope/vim-repeat).
+
+## Installation
+
+If you don't have a preferred installation method, I recommend
+installing [pathogen.vim](https://github.com/tpope/vim-pathogen), and
+then simply copy and paste:
+
+ cd ~/.vim/bundle
+ git clone git://github.com/tpope/vim-speeddating.git
+
+Once help tags have been generated, you can view the manual with
+`:help speeddating`.
+
+## Contributing
+
+See the contribution guidelines for
+[pathogen.vim](https://github.com/tpope/vim-pathogen#readme).
+
+## Self-Promotion
+
+Like speeddating.vim? Follow the repository on
+[GitHub](https://github.com/tpope/vim-speeddating) and vote for it on
+[vim.org](http://www.vim.org/scripts/script.php?script_id=2120). And if
+you're feeling especially charitable, follow [tpope](http://tpo.pe/) on
+[Twitter](http://twitter.com/tpope) and
+[GitHub](https://github.com/tpope).
+
+## License
+
+Copyright © Tim Pope. Distributed under the same terms as Vim itself.
+See `:help license`.
Please sign in to comment.
Something went wrong with that request. Please try again.