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