Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup for 1.3 #33

Merged
merged 1 commit into from
May 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,39 @@ In the git game, you guess who made a commit to your team's repo based on their

The goal is to get the longest streak! (It's harder than you think...)

## How do I play?
## Installation

### Homebrew
```sh
brew install git-game
```
### Download latest release

- [Download the `git-game` executable](https://github.com/jsomers/git-game/releases/tag/1.2)
- [Download the `git-game` executable](https://github.com/jsomers/git-game/releases/latest)
- Put it somewhere on your PATH (like /usr/local/bin)
- Then, in any git repository, run `git game`
- (If you'd like, you can select a subset of commits, for example, `git game --after={2014-08-08}`. For more options, see [Git - git-log documentation](https://git-scm.com/docs/git-log).)

## How do I play?

In any git repository, run:
```sh
git game
```
### Difficulty

The game defaults to normal difficulty, try this for a challenge:

```sh
git game --hard
```

### Extra options

If you'd like, you can select a subset of commits, for example; after August 8th 2014. Try:

```sh
git game --after={2014-08-08}
```
Most git log options are support. See [Git - git-log documentation](https://git-scm.com/docs/git-log)

## Requirements

Expand Down