Add docvim-generated documentation
authorGreg Hurrell <greg@hurrell.net>
Sun, 12 Jun 2016 22:11:09 +0000 (15:11 -0700)
committerGreg Hurrell <greg@hurrell.net>
Sun, 12 Jun 2016 22:11:09 +0000 (15:11 -0700)
README.md
doc/pinnacle.txt

index 784fbb418189c345de77ce3396d8e7a71a1d0357..e1d16ae02248597721f6b5916fe7630aa12243f7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
-# Intro
+# Pinnacle<a name="pinnacle-pinnacle" href="#user-content-pinnacle-pinnacle"></a>
 
-Pinnacle provides functions for manipulating `:highlight` groups.
+## Intro<a name="pinnacle-intro" href="#user-content-pinnacle-intro"></a>
 
-# Installation
+Pinnacle provides functions for manipulating <strong>`:highlight`</strong> groups.
+
+## Installation<a name="pinnacle-installation" href="#user-content-pinnacle-installation"></a>
 
 To install Pinnacle, 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 Pinnacle into `~/.vim/bundle`, you can do so with:
+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/pinnacle.git ~/.vim/bundle/pinnacle
@@ -25,7 +27,7 @@ To generate help tags under Pathogen, you can do so from inside Vim with:
 :call pathogen#helptags()
 ```
 
-# Website
+## Website<a name="pinnacle-website" href="#user-content-pinnacle-website"></a>
 
 The official Pinnacle source code repo is at:
 
@@ -41,7 +43,7 @@ Official releases are listed at:
 
 http://www.vim.org/scripts/script.php?script_id=5360
 
-# License
+## License<a name="pinnacle-license" href="#user-content-pinnacle-license"></a>
 
 Copyright (c) 2016-present Greg Hurrell
 
@@ -51,18 +53,18 @@ The above copyright notice and this permission notice shall be included in all c
 
 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
+## Development<a name="pinnacle-development" href="#user-content-pinnacle-development"></a>
 
-## Contributing patches
+### Contributing patches<a name="pinnacle-contributing-patches" href="#user-content-pinnacle-contributing-patches"></a>
 
 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/pinnacle/pulls
 
-## Cutting a new release
+### Cutting a new release<a name="pinnacle-cutting-a-new-release" href="#user-content-pinnacle-cutting-a-new-release"></a>
 
 At the moment the release process is manual:
 
 - Perform final sanity checks and manual testing
-- Update the [pinnacle-history](#user-content-pinnacle-history) section of the documentation
+- Update the <strong>[`pinnacle-history`](#user-content-pinnacle-history)</strong> section of the documentation
 - Verify clean work tree:
 
 ```
@@ -85,17 +87,17 @@ git push github master --follow-tags
 - Produce the release archive:
 
 ```
-git archive -o pinnacle-$VERSION.zip HEAD -- .
+git archive -o vim-docvim-$VERSION.zip HEAD -- .
 ```
 
 - Upload to http://www.vim.org/scripts/script.php?script_id=5360
 
-# Authors
+## Authors<a name="pinnacle-authors" href="#user-content-pinnacle-authors"></a>
 
 Pinnacle is written and maintained by Greg Hurrell <greg@hurrell.net>.
 
-# History
+## History<a name="pinnacle-history" href="#user-content-pinnacle-history"></a>
 
-## 0.1 (30 March 2016)
+### 0.1 (30 March 2016)<a name="pinnacle-01-30-march-2016" href="#user-content-pinnacle-01-30-march-2016"></a>
 
 - Initial release.
index f102b1c006b8e8995a0a92c51f91645008f8aa1d..d9033ceaba3c595ffab6ceef32e73c43c3e274d4 100644 (file)
@@ -103,7 +103,7 @@ At the moment the release process is manual:
 >
     git archive -o vim-docvim-$VERSION.zip HEAD -- .
 <
-- Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
+- Upload to http://www.vim.org/scripts/script.php?script_id=5360
 
 AUTHORS                                                       *pinnacle-authors*