Skip to content

Commit ba82635

Browse files
committed
feat: just
1 parent ebafb56 commit ba82635

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

docs/src/contributing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Most new code should have tests. It should also pass `cy`'s continuous integrati
88

99
To hack on `cy`, you only need a recent [Go toolchain](https://go.dev/doc/install) and a clone of [the cy repository](https://github.com/cfoust/cy).
1010

11+
For convenience, `cy` provides a configuration file for [just](https://github.com/casey/just), so you can execute commands like `just build`, `just lint`, `just test`, and `just run` and they will work as expected.
12+
1113
You can build and run `cy` from source with the following command. This is convenient for testing small changes.
1214

1315
```bash

docs/src/installation.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,12 @@ Download the latest version of `cy` on [the releases page](https://github.com/cf
2525
```bash
2626
git clone [email protected]:cfoust/cy.git
2727
cd cy
28-
go install ./cmd/cy/.
28+
29+
# if you have just installed: (https://github.com/casey/just)
30+
just install
31+
32+
# Otherwise
33+
go install ./cmd/cy/...
2934
```
3035

3136
## Terminal emulators

justfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
build:
2+
go build -o ./cy ./cmd/cy/...
3+
4+
install:
5+
go install ./cmd/cy/...
6+
7+
test:
8+
go test ./pkg/... ./cmd/...
9+
10+
lint:
11+
go fmt ./pkg/... ./cmd/...
12+
13+
run:
14+
go run ./cmd/cy/... -L dev

0 commit comments

Comments
 (0)