]> git.wincent.com - docvim.git/blob - tests/fixtures/vim/integration-pinnacle.golden
Add parser tests to integration tests
[docvim.git] / tests / fixtures / vim / integration-pinnacle.golden
1 *pinnacle.txt*           Highlight group manipulation for Vim           *pinnacle*
2
3 CONTENTS                                                     *pinnacle-contents*
4
5 1. Intro             |pinnacle-intro|
6 2. Installation      |pinnacle-installation|
7 3. Website           |pinnacle-website|
8 4. License           |pinnacle-license|
9 5. Development       |pinnacle-development|
10 6. Authors           |pinnacle-authors|
11 7. History           |pinnacle-history|
12
13 INTRO                                                           *pinnacle-intro*
14
15 Pinnacle provides functions for manipulating |:highlight| groups.
16
17 INSTALLATION                                             *pinnacle-installation*
18
19 To install Pinnacle, use your plug-in management system of choice.
20
21 If you don't have a "plug-in management system of choice", I recommend
22 Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and
23 robustness. Assuming that you have Pathogen installed and configured, and
24 that you want to install vim-docvim into `~/.vim/bundle`, you can do so with:
25 >
26     git clone https://github.com/wincent/pinnacle.git ~/.vim/bundle/pinnacle
27 <
28 Alternatively, if you use a Git submodule for each Vim plug-in, you could do
29 the following after `cd`-ing into the top-level of your Git superproject:
30 >
31     git submodule add https://github.com/wincent/pinnacle.git ~/vim/bundle/pinnacle
32     git submodule init
33 <
34 To generate help tags under Pathogen, you can do so from inside Vim with:
35 >
36     :call pathogen#helptags()
37 <
38 WEBSITE                                                       *pinnacle-website*
39
40 The official Pinnacle source code repo is at:
41
42 http://git.wincent.com/pinnacle.git
43
44 Mirrors exist at:
45
46 - https://github.com/wincent/pinnacle
47 - https://gitlab.com/wincent/pinnacle
48 - https://bitbucket.org/ghurrell/pinnacle
49
50 Official releases are listed at:
51
52 http://www.vim.org/scripts/script.php?script_id=[TODO]
53
54 LICENSE                                                       *pinnacle-license*
55
56 Copyright (c) 2016-present Greg Hurrell
57
58 Permission is hereby granted, free of charge, to any person obtaining a copy
59 of this software and associated documentation files (the "Software"), to
60 deal in the Software without restriction, including without limitation the
61 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
62 sell copies of the Software, and to permit persons to whom the Software is
63 furnished to do so, subject to the following conditions:
64
65 The above copyright notice and this permission notice shall be included in
66 all copies or substantial portions of the Software.
67
68 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
69 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
70 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
71 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
72 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
73 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
74 IN THE SOFTWARE.
75
76 DEVELOPMENT                                               *pinnacle-development*
77
78 Contributing patches ~
79
80 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests
81 at: https://github.com/wincent/pinnacle/pulls
82
83 Cutting a new release ~
84
85 At the moment the release process is manual:
86
87 - Perform final sanity checks and manual testing
88 - Update the |pinnacle-history| section of the documentation
89 - Verify clean work tree:
90 >
91     git status
92 <
93 - Tag the release:
94 >
95     git tag -s -m "$VERSION release" $VERSION
96 <
97 - Publish the code:
98 >
99     git push origin master --follow-tags
100     git push github master --follow-tags
101 <
102 - Produce the release archive:
103 >
104     git archive -o vim-docvim-$VERSION.zip HEAD -- .
105 <
106 - Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
107
108 AUTHORS                                                       *pinnacle-authors*
109
110 Pinnacle is written and maintained by Greg Hurrell <greg@hurrell.net>.
111
112 HISTORY                                                       *pinnacle-history*
113
114 0.1 (30 March 2016) ~
115
116 - Initial release.