]> git.wincent.com - pinnacle.git/blob - README.md
doc: Fix straggling references
[pinnacle.git] / README.md
1 # Intro
2
3 Pinnacle provides functions for manipulating `:highlight` groups.
4
5 # Installation
6
7 To install Pinnacle, use your plug-in management system of choice.
8
9 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:
10
11 ```
12 git clone https://github.com/wincent/pinnacle.git ~/.vim/bundle/pinnacle
13 ```
14
15 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:
16
17 ```
18 git submodule add https://github.com/wincent/pinnacle.git ~/vim/bundle/pinnacle
19 git submodule init
20 ```
21
22 To generate help tags under Pathogen, you can do so from inside Vim with:
23
24 ```
25 :call pathogen#helptags()
26 ```
27
28 # Website
29
30 The official Pinnacle source code repo is at:
31
32 http://git.wincent.com/pinnacle.git
33
34 Mirrors exist at:
35
36 - https://github.com/wincent/pinnacle
37 - https://gitlab.com/wincent/pinnacle
38 - https://bitbucket.org/ghurrell/pinnacle
39
40 Official releases are listed at:
41
42 http://www.vim.org/scripts/script.php?script_id=5360
43
44 # License
45
46 Copyright (c) 2016-present Greg Hurrell
47
48 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:
49
50 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
51
52 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.
53
54 # Development
55
56 ## Contributing patches
57
58 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/pinnacle/pulls
59
60 ## Cutting a new release
61
62 At the moment the release process is manual:
63
64 - Perform final sanity checks and manual testing
65 - Update the [pinnacle-history](#user-content-pinnacle-history) section of the documentation
66 - Verify clean work tree:
67
68 ```
69 git status
70 ```
71
72 - Tag the release:
73
74 ```
75 git tag -s -m "$VERSION release" $VERSION
76 ```
77
78 - Publish the code:
79
80 ```
81 git push origin master --follow-tags
82 git push github master --follow-tags
83 ```
84
85 - Produce the release archive:
86
87 ```
88 git archive -o pinnacle-$VERSION.zip HEAD -- .
89 ```
90
91 - Upload to http://www.vim.org/scripts/script.php?script_id=5360
92
93 # Authors
94
95 Pinnacle is written and maintained by Greg Hurrell <greg@hurrell.net>.
96
97 # History
98
99 ## 0.1 (30 March 2016)
100
101 - Initial release.