Add documentation generated by docvim
authorGreg Hurrell <greg@hurrell.net>
Sun, 12 Jun 2016 21:25:04 +0000 (14:25 -0700)
committerGreg Hurrell <greg@hurrell.net>
Sun, 12 Jun 2016 21:25:04 +0000 (14:25 -0700)
Now the circle is complete.

README.md [new file with mode: 0644]
doc/vim-docvim.txt [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..7f060b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,124 @@
+# docvim<a name="docvim-docvim" href="#user-content-docvim-docvim"></a>
+
+<p align="right"><a name="vim-docvim" href="#user-content-vim-docvim"><code>vim-docvim</code></a></p>
+## Intro<a name="docvim-intro" href="#user-content-docvim-intro"></a>
+
+vim-docvim provides additional syntax highlighting for Vim script files that contain embedded docvim comments.
+
+docvim (the tool, not this plug-in) is a documentation generator that processes those embedded comments and produces documentation in Markdown and Vim "help" formats. To avoid confusion, this document refers to the Vim plug-in as "vim-docvim" and the separate generation tool as "docvim".
+
+## Installation<a name="docvim-installation" href="#user-content-docvim-installation"></a>
+
+To install vim-docvim, use your plug-in management system of choice.
+
+If you don't have a "plug-in management system of choice", I recommend Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and robustness. Assuming that you have Pathogen installed and configured, and that you want to install vim-docvim into `~/.vim/bundle`, you can do so with:
+
+```
+git clone https://github.com/wincent/vim-docvim.git ~/.vim/bundle/vim-docvim
+```
+
+Alternatively, if you use a Git submodule for each Vim plug-in, you could do the following after `cd`-ing into the top-level of your Git superproject:
+
+```
+git submodule add https://github.com/wincent/vim-docvim.git ~/vim/bundle/vim-docvim
+git submodule init
+```
+
+To generate help tags under Pathogen, you can do so from inside Vim with:
+
+```
+:call pathogen#helptags()
+```
+
+## Related<a name="docvim-related" href="#user-content-docvim-related"></a>
+
+### Docvim<a name="docvim-docvim" href="#user-content-docvim-docvim"></a>
+
+The Docvim tool itself is a Haskell module, available at:
+
+http://hackage.haskell.org/package/docvim
+
+The official source code repo is at:
+
+http://git.wincent.com/docvim.git
+
+Mirrors exist at:
+
+- https://github.com/wincent/docvim
+- https://gitlab.com/wincent/docvim
+- https://bitbucket.org/ghurrell/docvim
+
+## Website<a name="docvim-website" href="#user-content-docvim-website"></a>
+
+The official vim-docvim source code repo is at:
+
+http://git.wincent.com/vim-docvim.git
+
+Mirrors exist at:
+
+- https://github.com/wincent/vim-docvim
+- https://gitlab.com/wincent/vim-docvim
+- https://bitbucket.org/ghurrell/vim-docvim
+
+Official releases are listed at:
+
+http://www.vim.org/scripts/script.php?script_id=[TODO]
+
+## License<a name="docvim-license" href="#user-content-docvim-license"></a>
+
+Copyright (c) 2015-present Greg Hurrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## Development<a name="docvim-development" href="#user-content-docvim-development"></a>
+
+### Contributing patches<a name="docvim-contributing-patches" href="#user-content-docvim-contributing-patches"></a>
+
+Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/vim-docvim/pulls
+
+### Cutting a new release<a name="docvim-cutting-a-new-release" href="#user-content-docvim-cutting-a-new-release"></a>
+
+At the moment the release process is manual:
+
+- Perform final sanity checks and manual testing
+- Update the <strong>[`docvim-history`](#user-content-docvim-history)</strong> section of the documentation
+- Verify clean work tree:
+
+```
+git status
+```
+
+- Tag the release:
+
+```
+git tag -s -m "$VERSION release" $VERSION
+```
+
+- Publish the code:
+
+```
+git push origin master --follow-tags
+git push github master --follow-tags
+```
+
+- Produce the release archive:
+
+```
+git archive -o vim-docvim-$VERSION.zip HEAD -- .
+```
+
+- Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
+
+## Authors<a name="docvim-authors" href="#user-content-docvim-authors"></a>
+
+vim-docvim is written and maintained by Greg Hurrell <greg@hurrell.net>.
+
+## History<a name="docvim-history" href="#user-content-docvim-history"></a>
+
+### 0.1 (not yet released)<a name="docvim-01-not-yet-released" href="#user-content-docvim-01-not-yet-released"></a>
+
+- Initial release.
diff --git a/doc/vim-docvim.txt b/doc/vim-docvim.txt
new file mode 100644 (file)
index 0000000..dd2c9c2
--- /dev/null
@@ -0,0 +1,143 @@
+*docvim.txt*            Syntax highlighting for docvim comments           *docvim*
+
+CONTENTS                                                       *docvim-contents*
+
+1. Intro           |docvim-intro|
+2. Installation    |docvim-installation|
+3. Related         |docvim-related|
+4. Website         |docvim-website|
+5. License         |docvim-license|
+6. Development     |docvim-development|
+7. Authors         |docvim-authors|
+8. History         |docvim-history|
+
+
+                                                                    *vim-docvim*
+INTRO                                                             *docvim-intro*
+
+vim-docvim provides additional syntax highlighting for Vim script files that
+contain embedded docvim comments.
+
+docvim (the tool, not this plug-in) is a documentation generator that
+processes those embedded comments and produces documentation in Markdown and
+Vim "help" formats. To avoid confusion, this document refers to the Vim
+plug-in as "vim-docvim" and the separate generation tool as "docvim".
+
+INSTALLATION                                               *docvim-installation*
+
+To install vim-docvim, use your plug-in management system of choice.
+
+If you don't have a "plug-in management system of choice", I recommend
+Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and
+robustness. Assuming that you have Pathogen installed and configured, and
+that you want to install vim-docvim into `~/.vim/bundle`, you can do so with:
+>
+    git clone https://github.com/wincent/vim-docvim.git ~/.vim/bundle/vim-docvim
+<
+Alternatively, if you use a Git submodule for each Vim plug-in, you could do
+the following after `cd`-ing into the top-level of your Git superproject:
+>
+    git submodule add https://github.com/wincent/vim-docvim.git ~/vim/bundle/vim-docvim
+    git submodule init
+<
+To generate help tags under Pathogen, you can do so from inside Vim with:
+>
+    :call pathogen#helptags()
+<
+RELATED                                                         *docvim-related*
+
+Docvim ~
+
+The Docvim tool itself is a Haskell module, available at:
+
+http://hackage.haskell.org/package/docvim
+
+The official source code repo is at:
+
+http://git.wincent.com/docvim.git
+
+Mirrors exist at:
+
+- https://github.com/wincent/docvim
+- https://gitlab.com/wincent/docvim
+- https://bitbucket.org/ghurrell/docvim
+
+WEBSITE                                                         *docvim-website*
+
+The official vim-docvim source code repo is at:
+
+http://git.wincent.com/vim-docvim.git
+
+Mirrors exist at:
+
+- https://github.com/wincent/vim-docvim
+- https://gitlab.com/wincent/vim-docvim
+- https://bitbucket.org/ghurrell/vim-docvim
+
+Official releases are listed at:
+
+http://www.vim.org/scripts/script.php?script_id=[TODO]
+
+LICENSE                                                         *docvim-license*
+
+Copyright (c) 2015-present Greg Hurrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+
+DEVELOPMENT                                                 *docvim-development*
+
+Contributing patches ~
+
+Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests
+at: https://github.com/wincent/vim-docvim/pulls
+
+Cutting a new release ~
+
+At the moment the release process is manual:
+
+- Perform final sanity checks and manual testing
+- Update the |docvim-history| section of the documentation
+- Verify clean work tree:
+>
+    git status
+<
+- Tag the release:
+>
+    git tag -s -m "$VERSION release" $VERSION
+<
+- Publish the code:
+>
+    git push origin master --follow-tags
+    git push github master --follow-tags
+<
+- Produce the release archive:
+>
+    git archive -o vim-docvim-$VERSION.zip HEAD -- .
+<
+- Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
+
+AUTHORS                                                         *docvim-authors*
+
+vim-docvim is written and maintained by Greg Hurrell <greg@hurrell.net>.
+
+HISTORY                                                         *docvim-history*
+
+0.1 (not yet released) ~
+
+- Initial release.