commit 67969911cc02fde2a94639307e1f2621cb9538ee Author: Felix Stupp Date: Thu May 14 18:07:48 2020 +0200 Initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ff9e935 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + +Copyright (C) 2004 Sam Hocevar + +Everyone is permitted to copy and distribute verbatim or modified +copies of this license document, and changing it is allowed as long +as the name is changed. + + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. You just DO WHAT THE FUCK YOU WANT TO. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b7aa2d5 --- /dev/null +++ b/README.md @@ -0,0 +1,97 @@ +# gtr Plugin for ZSH + +> gtr = git tag release + +Allows fast tagging of a release in git using the tag name release-YYYY-MM-DD-HH-MM and headline "Release YYYY-MM-DD HH:MM". +Git allows you to edit the headline and add a description using your default editor before +the tag will be signed and immediatily pushed to the primary remote repository. + +## Repository clones + +The original repository will be stored on [GitHub](https://github.com/Zocker1999NET/zsh-gtr). +You can use the original reopsitory if you want to use GitHub. +Also issues and pull requests will be collected there for convenience. + +This repository will be cloned to my own server. +You can use the [clone](https://git.banananet.work/zsh-plugins/gtr) instead of this repository +if you want to avoid use GitHub. + +## Installation + +### Prerequisites + +- `git` +- `gpg` + +### zsh (without plugin support) + +1. Clone project +2. Add following line to your `.zshrc`: +```sh +SOURCE "path/to/repo/gtr.plugin.zsh" +``` + +### oh-my-zsh + +1. Clone project into `~/.oh-my-zsh/custom/plugins/gtr` +2. Add `gtr` to your plugin list +```sh +plugins=(… gtr …) +``` + +### Antigen + +1. Add following line to your `.zshrc`: +```sh +antigen bundle Zocker1999NET/zsh-gtr # GitHub if default repository unchanged +antigen bundle https://git.banananet.work/zsh-plugins/gtr # Own Server +``` + +or + +1. Add the repository to your plugin list +```sh +antigen bundles <