Commit 3e90ae33 authored by Moritz Sokoll's avatar Moritz Sokoll 💬
Browse files

added help page

parent 314f186d
echo 'downloading files...'
echo 'preparing...'
call system("mkdir -p ~/.vim/plugins")
echo 'installing'
call system("mkdir -p ~/.vim/doc")
echo 'installing...'
call system("curl https://gitlab.sokoll.com/moritz/vim-git-control/-/raw/master/git-control.vim > ~/.vim/plugins/git-control.vim")
call system("curl https://gitlab.sokoll.com/moritz/vim-git-control/-/raw/master/git-control.txt > ~/.vim/doc/git-control.vim")
helptags ~/.vim/doc
echo 'done!'
......@@ -10,14 +10,14 @@ download the `.viminstall` file, open vim in the same directory and do `:VimInst
Download the file and move it to some path. Then add `source /path/to/git-control.vim` to your `.vimrc`
## Usage
`vim-git-control` comes with some commands:
- `:GitCommit`: prompts the user for a commit message and commits
- `:GitPush`: prompts the user for a remote (defaults to origin) and pushes to that remote
- `:GitCheckout`: prompts the use for a branch to checkout to
- `:GitStatus`: shows the git repository status
- `:GitBranch`: creates a new branch
- `:GitLog`: shows a git commit log
- `:GitInit`: initalize an empty git repository
- `:GitRemoteAdd`: add a new remote
- `:GitStage <file>`: stage a file/folder
- `:GitUnstage <file>`: unstage a file/folder
- `:GitRemotes`: show remotes
- `:GitCommit` - prompts the user for a commit message and commits
- `:GitPush` - prompts the user for a remote (defaults to origin) and pushes to that remote
- `:GitCheckout` - prompts the use for a branch to checkout to
- `:GitStatus` - shows the git repository status
- `:GitBranch` - creates a new branch
- `:GitLog` - shows a git commit log
- `:GitInit` - initalize an empty git repository
- `:GitRemoteAdd` - add a new remote
- `:GitStage <file>` - stage a file/folder
- `:GitUnstage <file>` - unstage a file/folder
- `:GitRemotes` - show remotes
*git-control.txt* For Vim version 8.2 Last change: 2021 June 7
Basic git integration for vim *git-control*
1. Commands |git-control-commands|
2. Installation & Updating |git-control-install|
==============================================================================
1. Commands *git-control-commands*
*:GitStatus* *git-status*
:GitStatus Show the git status in the short message format.
*:GitLog* *git-log*
:GitLog Show the git commit history as one line per commit
and a ascii graph.
*:GitCommit* *git-commit*
:GitCommit Prompt the user for a commit message and commit all
staged changes with this message (see |git-stage|,
|git-push| and |git-unstage|).
*:GitStage* *git-stage*
:GitStage {path} Stage {path} (can be both a file and directory).
*:GitUnstage* *git-unstage*
:GitUnstage {path} Unstage {path} (can be both a file and directory).
*:GitPush* *git-push*
:GitPush Prompt the user for a remote to push to (defaults to
'origin') and push changes.
*:GitBranch* *git-branch*
:GitBranch Prompt the user for a name and create a branch with
that name.
*:GitCheckout* *git-checkout*
:GitCheckout Prompt the user for a branch to checkout to.
*:GitInit* *git-init*
:GitInit Initalize a new git repository.
*:GitRemotes* *git-remotes*
:GitRemotes Show all remotes for this repository.
*:GitRemoteAdd* *git-remote-add*
:GitRemoteAdd Prompt the user for a remote name and url and add a new
remote using these as parameters
(see |git-remote-add|).
==============================================================================
2. Installation & Updating *git-control-install*
To install git-control you can use |vim-install|. To update it you can do the
same. It will overwrite the old one.
vim:tw=78:ts=8:noet:ft=help:norl:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment