Skip to content

Commit

Permalink
Add installation instructions, release checklist [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
sondr3 committed Apr 18, 2019
1 parent a4c0980 commit 94d14f8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 6 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Release checklist

- [ ] Update version in `Cargo.toml`
- [ ] Create release commit
- [ ] Create a changelog from commits from previous release to this release,
ammend it onto release commit.
- [ ] Create a annotated tag (`git tag -a vN.N.N`)
- [ ] Update [Homebrew](https://github.com/sondr3/homebrew-taps)
- [ ] Update [Nixpkgs](https://github.com/sondr3/nixpkgs/blob/master/pkgs/applications/version-management/git-and-tools/git-ignore/default.nix)
- [ ] Update AUR package
- [ ] Add changelog entry to release on GitHub
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,27 @@ even works offline by caching the templates!

# Installation

There are two ways of installing it, either via Cargo (easiest) or via Nix
(authors preference). See installation and usage instructions below.
There are a couple of ways of installing it. See installation and usage
instructions below.

## Cargo

Make sure you have Rust installed (I recommend installing via
[rustup](https://rustup.rs/)), then run `cargo install git-ignore-generator`.
`cargo install git-ignore-generator`.

## Nix

Run `nix-env -iA nixpkgs.gitAndTools.git-ignore`. This version also includes man
pages.
Run `nix-env -iA nixpkgs.gitAndTools.git-ignore`. This includes man pages.

## Homebrew

Add my personal Homebrew taps repository with `brew tap sondr3/homebrew-taps`
and then install it with `brew install git-ignore`. This includes man pages.

## Arch

It's available as a binary package from
[AUR](https://aur.archlinux.org/packages/git-ignore-bin/). Install it with your
favorite AUR helper. `yay git-ignore`. This includes man pages.

# Usage

Expand Down

0 comments on commit 94d14f8

Please sign in to comment.