Skip to content

Commit

Permalink
few readme cleaups (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
retr0h committed Nov 12, 2023
1 parent 5beafd2 commit 7d6497c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 24 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
cobertura.xml
cover.out
result.xml
dist/
29 changes: 5 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,44 +55,25 @@ and/or directories to the desired destinations.

Overlay a remote repository into the destination provided.

```bash
$ gilt overlay
```
$ gilt overlay

Use an alternate config file (default `gilt.yml`).

```bash
$ gilt overlay --filename /path/to/gilt.yml
```
$ gilt overlay --filename /path/to/gilt.yml

Optionally, override gilt's cache location (defaults to `~/.gilt/clone`):

```bash
$ gilt --giltdir ~/alternate/directory overlay
```
$ gilt --giltdir ~/alternate/directory overlay

### Debug

Display the git commands being executed.

```bash
$ gilt --debug overlay
```

[![asciicast](https://asciinema.org/a/195036.png)](https://asciinema.org/a/195036?speed=2&autoplay=1&loop=1)

## Dependencies

```bash
$ go get github.com/golang/dep/cmd/dep
```
$ gilt --debug overlay

## Building

```bash
$ make build
$ tree .build/
```
$ task build

## Testing

Expand Down

0 comments on commit 7d6497c

Please sign in to comment.