https://github.com/woodruffw/git-contrib
MIGRATED. Contributors file generator for git repositories.
https://github.com/woodruffw/git-contrib
Last synced: 8 months ago
JSON representation
MIGRATED. Contributors file generator for git repositories.
- Host: GitHub
- URL: https://github.com/woodruffw/git-contrib
- Owner: woodruffw
- License: mit
- Archived: true
- Created: 2014-07-08T17:27:06.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-05-12T18:14:27.000Z (over 10 years ago)
- Last Synced: 2025-01-22T02:12:19.464Z (9 months ago)
- Language: Ruby
- Homepage: http://woodruffw.us/snippets.html
- Size: 148 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
git-contrib
==========
# MIGRATED
I will no longer be making changes to this repository. The current code has
been migrated to my [snippets](http://woodruffw.us/snippets.html) and the
[corresponding repo](https://github.com/woodruffw/snippets).
`git-contrib` is a neat little script for creating CONTRIBUTORS files for git repositories.
It can currently generate Markdown (GitHub-flavored), CSV, and plain text files using git's logging facilities.
## Installation and Usage:
First, clone the reposity or download the `git-contrib.rb` file otherwise.
```bash
$ git clone https://github.com/woodruffw/git-contrib.git
```
Place the `git-contrib.rb` file somewhere in your `$PATH`, removing the ".rb" if you don't want the suffix.
Then, just execute it in your git repository/repositories:
```bash
git contrib.rb # generate plain-text CONTRIBUTORS
git contrib.rb --markdown # generate CONTRIBUTORS.md
git contrib.rb --csv # generate CONTRIBUTORS.csv
```
## Examples
See [CONTRIBUTORS.md](CONTRIBUTORS.md), [CONTRIBUTORS.csv](CONTRIBUTORS.csv), and plain old [CONTRIBUTORS](CONTRIBUTORS)