Skip to content

Mark shell code blocks #22

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ See [releases](https://github.com/sinclairtarget/git-who/releases).

### Package Managers
#### Mac OS
```
$ brew install git-who
```sh
brew install git-who
```

#### Arch Linux
Expand All @@ -37,11 +37,11 @@ installed. Note that these are _only_ required when building from source; you
can download and run one of the binary releases without installing any of these
tools.

```
$ git clone [email protected]:sinclairtarget/git-who.git
$ cd git-who
$ rake
$ ./git-who --version
```sh
git clone [email protected]:sinclairtarget/git-who.git
cd git-who
rake
./git-who --version
```

## Usage
Expand Down Expand Up @@ -146,8 +146,8 @@ and a commit-ish, you can use `--` to clarify the distinction. The
following command will show you contributions to the file or directory
called `foo` even if there is also a branch called `foo` in your repository (or
even if the file/directory was previously committed but has since been deleted):
```
$ git who -- foo
```sh
git who -- foo
```

#### Options
Expand Down Expand Up @@ -610,7 +610,7 @@ system directly. Follow these steps to build and use the Docker image.
### Building the Docker Image
To build the `git-who` Docker image, run the following command from the project root:

```
```sh
docker build -t git-who -f docker/Dockerfile .
```

Expand All @@ -619,7 +619,7 @@ This will create a Docker image named `git-who` that you can use to run the tool
### Running `git-who` via Docker
To use git-who without modifying your Git configuration, you can manually run:

```
```sh
docker run --rm -it -v "$(pwd)":/git -v "$HOME":/root git-who who
```

Expand All @@ -639,7 +639,7 @@ configuration. Add the following lines to your `~/.gitconfig` file:

This allows you to run:

```
```sh
git who
```

Expand Down Expand Up @@ -711,6 +711,6 @@ A test repository is attached to this repository as a submodule.
If you want to run the automated tests, you will first need to set up the
submodule:

```
$ git submodule update --init
```sh
git submodule update --init
```