README.md

   1 # docvim<a name="docvim-docvim" href="#user-content-docvim-docvim"></a>
   2
   3 <p align="right"><a name="vim-docvim" href="#user-content-vim-docvim"><code>vim-docvim</code></a></p>
   4 ## Intro<a name="docvim-intro" href="#user-content-docvim-intro"></a>
   5
   6 vim-docvim provides additional syntax highlighting for Vim script files that contain embedded docvim comments.
   7
   8 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".
   9
  10 ## Installation<a name="docvim-installation" href="#user-content-docvim-installation"></a>
  11
  12 To install vim-docvim, use your plug-in management system of choice.
  13
  14 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:
  15
  16 ```
  17 git clone https://github.com/wincent/vim-docvim.git ~/.vim/bundle/vim-docvim
  18 ```
  19
  20 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:
  21
  22 ```
  23 git submodule add https://github.com/wincent/vim-docvim.git ~/vim/bundle/vim-docvim
  24 git submodule init
  25 ```
  26
  27 To generate help tags under Pathogen, you can do so from inside Vim with:
  28
  29 ```
  30 :call pathogen#helptags()
  31 ```
  32
  33 ## Related<a name="docvim-related" href="#user-content-docvim-related"></a>
  34
  35 ### Docvim<a name="docvim-docvim" href="#user-content-docvim-docvim"></a>
  36
  37 The Docvim tool itself is a Haskell module, available at:
  38
  39 http://hackage.haskell.org/package/docvim
  40
  41 The official source code repo is at:
  42
  43 http://git.wincent.com/docvim.git
  44
  45 Mirrors exist at:
  46
  47 - https://github.com/wincent/docvim
  48 - https://gitlab.com/wincent/docvim
  49 - https://bitbucket.org/ghurrell/docvim
  50
  51 ## Website<a name="docvim-website" href="#user-content-docvim-website"></a>
  52
  53 The official vim-docvim source code repo is at:
  54
  55 http://git.wincent.com/vim-docvim.git
  56
  57 Mirrors exist at:
  58
  59 - https://github.com/wincent/vim-docvim
  60 - https://gitlab.com/wincent/vim-docvim
  61 - https://bitbucket.org/ghurrell/vim-docvim
  62
  63 Official releases are listed at:
  64
  65 http://www.vim.org/scripts/script.php?script_id=[TODO]
  66
  67 ## License<a name="docvim-license" href="#user-content-docvim-license"></a>
  68
  69 Copyright (c) 2015-present Greg Hurrell
  70
  71 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:
  72
  73 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  74
  75 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.
  76
  77 ## Development<a name="docvim-development" href="#user-content-docvim-development"></a>
  78
  79 ### Contributing patches<a name="docvim-contributing-patches" href="#user-content-docvim-contributing-patches"></a>
  80
  81 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/vim-docvim/pulls
  82
  83 ### Cutting a new release<a name="docvim-cutting-a-new-release" href="#user-content-docvim-cutting-a-new-release"></a>
  84
  85 At the moment the release process is manual:
  86
  87 - Perform final sanity checks and manual testing
  88 - Update the <strong>[`docvim-history`](#user-content-docvim-history)</strong> section of the documentation
  89 - Verify clean work tree:
  90
  91 ```
  92 git status
  93 ```
  94
  95 - Tag the release:
  96
  97 ```
  98 git tag -s -m "$VERSION release" $VERSION
  99 ```
 100
 101 - Publish the code:
 102
 103 ```
 104 git push origin master --follow-tags
 105 git push github master --follow-tags
 106 ```
 107
 108 - Produce the release archive:
 109
 110 ```
 111 git archive -o vim-docvim-$VERSION.zip HEAD -- .
 112 ```
 113
 114 - Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
 115
 116 ## Authors<a name="docvim-authors" href="#user-content-docvim-authors"></a>
 117
 118 vim-docvim is written and maintained by Greg Hurrell <greg@hurrell.net>.
 119
 120 ## History<a name="docvim-history" href="#user-content-docvim-history"></a>
 121
 122 ### 0.1 (not yet released)<a name="docvim-01-not-yet-released" href="#user-content-docvim-01-not-yet-released"></a>
 123
 124 - Initial release.