mirror of
https://github.com/zdharma-continuum/zinit-annex-submods.git
synced 2026-09-10 07:16:18 -04:00
Initial commit (.gitignore, LICENSE, README.md)
This commit is contained in:
commit
512d448069
16
.gitignore
vendored
Normal file
16
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
|
||||
### Vim
|
||||
# Swap
|
||||
[._]*.s[a-v][a-z]
|
||||
[._]*.sw[a-p]
|
||||
[._]s[a-v][a-z]
|
||||
[._]sw[a-p]
|
||||
|
||||
# Session
|
||||
Session.vim
|
||||
|
||||
# Temporary
|
||||
.netrwhist
|
||||
*~
|
||||
# Auto-generated tag files
|
||||
tags
|
||||
22
LICENSE
Normal file
22
LICENSE
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
This software is licensed under MIT.
|
||||
|
||||
MIT License
|
||||
-----------
|
||||
|
||||
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:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
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.
|
||||
29
README.md
Normal file
29
README.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# Introduction
|
||||
|
||||
A z-plugin (i.e. a plugin for the [Zplugin](https://github.com/zdharma/zplugin)) that
|
||||
allows Zpluugin to clone submodules when installing a plugin or snippet.
|
||||
|
||||
It adds `submod''` ice to Zplugin with a following syntax:
|
||||
|
||||
```zsh
|
||||
submod'{user}/{plugin} -> {output directory}; ...'
|
||||
```
|
||||
|
||||
So the example command using the z-plugin and its ice is e.g.
|
||||
|
||||
```zsh
|
||||
# Load the zsh-autosuggestions plugin via Prezto module autosuggestions
|
||||
zplugin ice svn submod'zsh-users/zsh-autosuggestions -> external'
|
||||
zplugin snippet PZT::modules/autosuggestions
|
||||
```
|
||||
|
||||
# Installation
|
||||
|
||||
Simply load as a plugin. This will install the z-plugin within Zplugin:
|
||||
|
||||
```zsh
|
||||
zplugin light zdharma/z-p-submods
|
||||
```
|
||||
|
||||
<!-- vim:tw=85
|
||||
-->
|
||||
Loading…
Reference in a new issue