]> git.wincent.com - docvim.git/commitdiff
Upgrade README
authorGreg Hurrell <greg@hurrell.net>
Tue, 31 May 2016 14:12:21 +0000 (07:12 -0700)
committerGreg Hurrell <greg@hurrell.net>
Tue, 31 May 2016 14:12:21 +0000 (07:12 -0700)
README.md

index a64b0b236362def07786692dda7666d3f5cf0bff..0e8dc22cc2d7e8539edf9eb788db49a0e753d81f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,23 +1,40 @@
 # Beware!
 
-Docvim is a work in progress. It doesn't actually do anything useful yet.
-
-In the meantime, here is some autogenerated dummy-text for you to read:
-
-> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam sit amet mi non urna vehicula imperdiet. Nulla tincidunt vehicula erat. Nulla sodales gravida arcu, in bibendum sem fringilla sagittis. Curabitur eget lorem ullamcorper, consequat erat vitae, rutrum odio. Vivamus fermentum lorem ante, ut imperdiet dui iaculis in. Donec quis ante placerat, porttitor massa id, luctus augue. Integer sapien elit, mattis non porta a, rutrum eget eros. Mauris ipsum nisi, porta at aliquam sed, viverra ac magna. Aliquam et consequat justo. Suspendisse at orci id erat dictum efficitur nec vel massa. Ut sollicitudin, quam at condimentum maximus, leo arcu aliquet massa, non rutrum metus justo nec velit. Aenean tincidunt ipsum eu urna ultricies facilisis. Cras et ex turpis.
->
-> Mauris tempor, nunc eget ultricies malesuada, purus elit porta neque, a blandit orci arcu vitae nunc. Proin molestie tempor pellentesque. Cras ac aliquam arcu. Mauris mattis lorem eu gravida bibendum. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum lacus ligula, tincidunt sit amet porttitor eget, porttitor id urna. Donec sodales gravida imperdiet. Nulla odio felis, luctus lacinia velit sit amet, pretium cursus diam. Nulla a ultricies ante. Praesent egestas eros ac ex porttitor, quis facilisis velit vulputate. Vestibulum dictum, nulla vitae hendrerit mattis, dolor risus convallis nunc, sit amet eleifend mi erat in ante. Mauris nec vehicula eros. Curabitur dapibus dolor id tristique auctor. Fusce commodo elit nec risus vulputate vulputate.
->
-> Mauris eros nunc, faucibus et tincidunt sed, fringilla et nulla. Sed quam velit, fermentum non dignissim a, consectetur eget sapien. Mauris laoreet ornare dui quis laoreet. Cras lectus velit, tempor vulputate est vel, maximus sodales nulla. Proin vitae neque sit amet dolor porta facilisis in vitae orci. Suspendisse enim magna, ullamcorper id molestie suscipit, pulvinar tempor lectus. Mauris mi mi, feugiat id augue efficitur, laoreet varius nunc. Proin suscipit euismod aliquam. Donec quis mi ut massa sagittis rhoncus.
->
-> Duis libero lorem, porttitor non libero et, dapibus interdum sapien. Nullam laoreet ante sit amet convallis mattis. Curabitur vitae nulla porta, sagittis lacus in, consequat nunc. Aliquam cursus elementum pretium. Fusce consequat interdum elit et tempus. Nullam nec neque eget ex tempor dapibus dignissim ac odio. Nunc consectetur sem eu nibh dictum fringilla. In volutpat molestie magna, congue mattis lorem rutrum ut. Donec malesuada, odio a cursus consectetur, metus augue tincidunt nulla, ut accumsan augue quam in turpis.
->
-> Praesent fringilla viverra vestibulum. Curabitur commodo, ex tempor posuere sodales, eros nisi blandit odio, ut venenatis dui libero in enim. Nunc semper turpis eget laoreet mollis. Pellentesque luctus massa ut metus volutpat, a lacinia diam pellentesque. Sed eget odio ullamcorper, faucibus metus a, porttitor quam. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Maecenas vehicula, quam a molestie maximus, ligula ligula porttitor purus, non mattis velit velit ac lacus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Fusce porttitor tristique ligula, vel imperdiet turpis ultrices non. Etiam condimentum mi ligula.
+Docvim is a work in progress. It barely does anything useful at this point.
 
 # docvim: a documentation generator for Vim plug-ins
 
 docvim is a documentation generator for Vim plug-ins, written in Haskell.
 
+## Quickstart
+
+```bash
+# Print Markdown-formatted help documentation for files in current directory
+docvim
+
+# Write Markdown README + Vim help text file for $PLUGIN
+docvim -c ~/code/$PLUGIN ~/code/$PLUGIN/doc/$PLUGIN.txt ~/code/$PLUGIN/README.md
+```
+
+## Usage
+
+```
+docvim - a documentation generator for Vim plug-ins
+
+Usage: docvim [--version] [OUTFILES...] [-d|--debug] [-c|--directory DIRECTORY]
+              [-v|--verbose]
+  Generate documentation for a Vim plug-in
+
+Available options:
+  -h,--help                Show this help text
+  --version                Print version information
+  OUTFILES...              Target file(s) for generated output (default:
+                           standard output)
+  -d,--debug               Print debug information during processing
+  -c,--directory DIRECTORY Change to DIRECTORY before processing (default: ".")
+  -v,--verbose             Be verbose during processing
+```
+
 ## Development
 
 ### Convenience wrappers