From 461b0e8969b89ea37cc78867f333494b1d0e5de2 Mon Sep 17 00:00:00 2001 From: Tucker Evans Date: Tue, 6 Mar 2018 21:58:02 -0500 Subject: Adds License, Readme, and man files --- LICENSE | 21 +++++++++++++ README.rst | 77 ++++++++++++++++++++++++++++++++++++++++++++++ man/plug.1 | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 199 insertions(+) create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 man/plug.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b15c7b6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Tucker Evans + +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. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..51def02 --- /dev/null +++ b/README.rst @@ -0,0 +1,77 @@ +plugVim +======= + +A vim plugin manager that uses vim 8's native plugin support and git +submodules. If you want more information on the basics of this I +recommend reading `Vim: So long Pathogen, hello native package loading +`_, as it was my reference when +creating the script. + +Table of Contents +----------------- + +- `Installation`_ +- `Usage`_ +- `Examples`_ +- `License`_ + + +Installation +------------ + +.. code :: + + git clone git@github.com:tuckerevans/plugvim.git + cd plugvim + make install + +Usage +----- + +Commands +~~~~~~~~ +- install +- update +- remove +- list +- help +- version + +Options +~~~~~~~ + +- **-g "local git directory"** default: ~/dotfiles/ +- **-d "directory containing .vim"** default: GIT_REPO/vim/ +- **-o** place plugin in opt folder instead of start. +- **-c** commit changes + +Examples +~~~~~~~~ +Installing `gitgutter ` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +- Basic: + :code:`plug install https://github.com/airblade/vim-gitgutter.git` +- Install gitgutter and commit changes: + :code:`plug install -oc https://github.com/airblade/vim-gitgutter.git` +- In a different Git repository (not \*/dotfiles): + :code:`plug install -g path/to/different/repo https://github.com/airblade/vim-gitgutter.git` + +Updating all plugins +^^^^^^^^^^^^^^^^^^^^ +- Basic: + :code:`plug update` +- With a set number(8) of threads: + :code:`plug update -j 8` + +Removing `gitgutter ` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +- Basic: + :code:`plug remove gitgutter` +- If gitgutter was installed in opt directory: + :code:`plug remove -o gitgutter` +- If .vim is not located in ``GIT_REPO/vim`` + :code:`plug remove -d path/to/parent/of/.vim` + +License +------- +`MIT `_ diff --git a/man/plug.1 b/man/plug.1 new file mode 100644 index 0000000..14cf7f2 --- /dev/null +++ b/man/plug.1 @@ -0,0 +1,101 @@ +.TH PLUG 1 "2018 February 15" "PlugVim 0.0.1" "PlugVim Manual" +.SH NAME +plug - manages vim plugins using git submodules + +.SH SYNOPSIS +.nf +\fBplug install\fP [] "remote git repo" +\fBplug update\fP [] +\fBplug remove\fP [] plugin-name +\fBplug list\fP [] +\fBplug help\fP +\fBplug version\fP +.fi + +.SH DESCRIPTION +plug is a simple vim plugin manager that uses vim 8's native plugin +support and git submodules. + + +.SH COMMANDS +.TP +\fBinstall\fP [\fI-oc\fP] [-g \fIGIT-REPO\fP] [-d \fI.vim-LOCATION\fP] plugin-name + +Install plugin at remote git repo as submodule in GIT-REPO. + + +.TP +\fBupdate\fP [\fI-c\fP] [-g \fIGIT-REPO\fP] [-j \fITHREAD-COUNT\fP] "remote git repo" +Update all git modules. + +.TP +\fBremove\fP [\fI-oc\fP] [-g \fIGIT-REPO\fP] [-d \fI.vim-LOCATION\fP] plugin-name +Remove plugin. + +.TP +\fBlist\fP [-g \fIGIT-REPO\fP] +List installed plugins. + +.TP +\fBhelp\fP +Display usage information. + +.TP +\fBversion\fP +Display version information. + +.SH OPTIONS +.PP +\-o +.RS 4 +Store plugin in opt folder rather than start. +.RE + +.PP +\-c +.RS 4 +Commit changes to repo. This will commit any staged changes, I +recommend committing these with a meaningful message before committing +with plug. +.RE + +.PP +\-g \fIGIT-REPO\fP +.RS 4 +Use GIT-REPO as directory for git commands uses "git -C +GIT-REPO" +Default: ~/dotfiles/ +.RE + +.PP +\-d \fIdirectory\fP +.RS 4 +Uses directory as location of .vim in git repo +Default: GIT_REPO/vim/ +.RE + +.PP +\-j +.RS 4 +Number of jobs for "git submodule update" to use. +.RE + +.SH AUTHOR +.B plug +was written by +.MT tuckerevans24@gmail.com +Tucker Evans +.ME . + +.SH "SEE ALSO" +git-submodule(1), vim(1) + +.SH BUGS +This is a very early version, there are probably, I'm just not aware +of them yet. +.PP +You can report bugs +.UR https://github.com/tuckerevans/plugvim/issues +here +.UE . + -- cgit v1.1