add README

This commit is contained in:
Motonori Iwata 2011-09-03 23:34:36 +09:00
parent 6c997f43f9
commit e3e5c5f24c
2 changed files with 63 additions and 2 deletions

61
README.mdown Normal file
View file

@ -0,0 +1,61 @@
git-now
========
``git-now`` is a command-line tool for light and temporary commit
with a log message from time now and diff.
Usage
---------------
Create a temporary commit:
$ git now
You can use the same option as ``git add``.
$ git now [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
[--edit | -e] [--all | [--update | -u]] [--intent-to-add | -N]
[--refresh] [--ignore-errors] [--ignore-missing] [--]
[<filepattern>...]
### Subcommands
Available subcommands are:
* rebase - rebase for temporary commits.
* grep - grep temporary commits.
_Try 'git now \<subcommand\> help' for details._
Installation
-------------------
### Mac OS
If you're on a Mac and use [homebrew](http://github.com/mxcl/homebrew), it's simple:
$ brew install https://github.com/iwata/git-now/raw/master/git-now.rb
### Manual installation
If you prefer a manual installation, please use the following instructions:
$ git clone --recursive git://github.com/iwata/git-now.git
Then, you can install `git-now`, using:
$ sudo make install
By default, git-now will be installed in /usr/local. To change the prefix
where git-now will be installed, simply specify it explicitly, using:
$ sudo make prefix=/opt/local install
Or simply point your `PATH` environment variable to your git-now checkout
directory.
Special Thanks
---------------
* [An original git-now idea](http://d.hatena.ne.jp/sinsoku/20101208/1291770514) (by [Toshiyuki Kawanishi](https://github.com/toshi-kawanishi))
* [Installation with homebrew](http://d.hatena.ne.jp/nobeans/20110322/1300776839) (by [Yasuharu NAKANO](https://github.com/nobeans))

View file

@ -1,8 +1,8 @@
require 'formula'
class GitNow < Formula
url 'https://github.com/iwata/git-now.git', :tag => 'v0.0.1'
version '0.0.1'
url 'https://github.com/iwata/git-now.git', :tag => 'v0.0.2'
version '0.0.2'
head 'https://github.com/iwata/git-now.git', :branch => 'develop'
homepage 'https://github.com/iwata/git-now'