Skip to content
This repository has been archived by the owner on Dec 29, 2017. It is now read-only.

Commit

Permalink
added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vanessa McHale committed Mar 1, 2017
1 parent afc933b commit 0297323
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
2 changes: 1 addition & 1 deletion TODO.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- [ ] generate vim docs
- [x] generate vim docs
39 changes: 39 additions & 0 deletions docs/tokei.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
*tokei.txt* Use tokei without leaving vim!
_____ _ _ _
|_ _|__ | | _____(_) __ _(_)_ __ ___
| |/ _ \| |/ / _ \ | \ \ / / | '_ ` _ \
| | (_) | < __/ | \ V /| | | | | | |
|_|\___/|_|\_\___|_| \_/ |_|_| |_| |_|

Count code not calories.
====================================================================
CONTENTS *TokeiContents*

1. Usage ................ |TokeiUsage|
2. Config ............. |TokeiConfig|
3. License .............. |TokeiLicense|

====================================================================
Section 1: Usage *TokeiUsage*

By default, tokei-vim provides a command and a keybinding, viz.

:Tokei *:Tokei*
Run tokei and output to a scratch buffer, e.g. >
:Tokei

<silent> co......Run tokei...............................|Tokei-co|

=====================================================================
Section 2: Config *TokeiConfig*

----------------------------------------------------------------------
*'g:tokei_exclude'*
Values: Filepaths to exclude
Default: 'TODO.md'

This excludes any particular filepaths, in addition to anything in
your gitignore. Files to exclude should be separated commas but no
spaces, e.g. >
let g:tokei_exclude='TODO.md,README.md'
<
4 changes: 4 additions & 0 deletions vimball.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
docs/tokei.txt
plugin/tokei.vim
README.md
LICENSE

0 comments on commit 0297323

Please sign in to comment.