README.md in githelp-0.1.2 vs README.md in githelp-0.1.3

- old
+ new

@@ -1,41 +1,79 @@ -# Githelp +# GitHelp -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/githelp`. To experiment with that code, run `bin/console` for an interactive prompt. +**Gitのコマンドの使いこなしを支援する** -TODO: Delete this and the text above, and describe your gem +### 解決したい問題 -## Installation +* Gitの使い方や引数指定方法がさっぱりわからないこと +* ちょっとしたことでもどうコマンドを組み合わせれば良いのかわからないこと -Add this line to your application's Gemfile: +以下のような処理をGitでどうやって実行するかを教えてくれる -```ruby -gem 'githelp' -``` +* example.txtは3日前からどう変わった? +* 3日前のexample.txtを見たい +* package.jsonからcoffeeという名前が消えたのはいつ? +* ここ1週間ぐらい変更されてないファイルは? +* 最近最も大量に修正したファイルはどれだっけ? -And then execute: +### 利用例 - $ bundle +* ```README``` ```8``` ```比較``` のような引数を指定して```githelp```コマンドを起動すると以下のような候補が提示される -Or install it yourself as: +``` +$ githelp README 8 比較 +[0] 「README.md」ファイルを8分前のものと比較する + % git diff HEAD "@{8 minutes ago}" README.md +[1] 「README.md」ファイルを8時間前のものと比較する + % git diff HEAD "@{8 hours ago}" README.md +[2] 「README.md」ファイルを8日前のものと比較する + % git diff HEAD "@{8 days ago}" README.md +$ +``` - $ gem install githelp +* ```-x``` オプションで数字を指定すると実行できる -## Usage -TODO: Write usage instructions here +``` +$ githelp README 8 比較 -x2 +diff --git a/README.md b/README.md +index 862f185..34c8907 100644 +--- a/README.md ++++ b/README.md +@@ -1,90 +1,3 @@ + # GitHelp + +-**Gitのコマンドの使いこなしを支援する** +- +-### 解決したい問題 +- +-* Gitの使い方や引数指定方法がさっぱりわからないこと +-* ちょっとしたことでもどうコマンドを組み合わせれば良いのかわからないこと +... +``` -## Development +* ```-i``` オプションを指定すると対話的に選択できる +* 引数なしで```githelp```を起動するとリストが表示される -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +### 実装 -## Contributing +* [ExpandHelp](https://github.com/masui/expand_ruby)を利用 +* [ExpandHelp論文](http://www.interaction-ipsj.org/archives/paper2012/data/Interaction2012/oral/data/pdf/12INT012.pdf) +* [```data```](https://github.com/masui/GitHelp/tree/master/data)ディレクトリの下に問題パタンと解決コマンドを書く + * ワンライナーで無理な場合は ```bin``` の下にコマンドを用意する -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/githelp. +### インストール +``` +% gem install githelp +``` -## License +### お願い -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +データが全然足りないので、こういうのを足せという情報があればお願いいたします。 +### 考察とか + +* Siriみたいなのでやるのがトレンドな気もするが、自分が何をやりたいのかはっきりわかってない場合でも使えるし、正しいセンテンスを指定する必要もないから楽だと思う + * ```githelp 削除``` とか言えば何ができるのかわかる +* もちろんこのやり方はGit以外でも有効である