Skip to content

Commit 5d60088

Browse files
committed
📝 Update install section and contributing
1 parent 3f1b001 commit 5d60088

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,22 @@ yutu is a cli tool built using the [cobra](https://github.com/spf13/cobra). Feel
55
- Commit messages should follow the [gitmoji](https://gitmoji.dev) convention.
66
- Follow the existing naming and project structure.
77

8-
**Tests are especially welcomed**, as they are currently missing from the project.
8+
Here are some commands which may useful.
9+
10+
```shell
11+
# upgrade all dependencies
12+
❯ go get -u ./...
13+
14+
# run tests
15+
## unit tests
16+
❯ go test ./...
17+
## verify binary commands, detect shorthands conflicts, etc.
18+
❯ ./scripts/command-test.sh
19+
20+
# build the binary
21+
## install goreleaser: https://goreleaser.com/install
22+
❯ GITHUB_REPOSITORY=eat-pray-ai/yutu goreleaser build --clean --auto-snapshot
23+
24+
# script to install yutu
25+
❯ ./scripts/install.sh
26+
```

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,17 +95,15 @@ There are two actions available for yutu, one is for general purpose and the oth
9595
### Linux
9696

9797
```shell
98-
❯ curl -sSfL https://github.com/eat-pray-ai/yutu/releases/latest/download/yutu-linux-$(uname -m) -o /usr/local/bin/yutu
99-
❯ chmod +x /usr/local/bin/yutu
98+
❯ curl -sSfL https://raw.githubusercontent.com/eat-pray-ai/yutu/main/scripts/install.sh | bash
10099
```
101100

102101
### macOS
103102

104-
Homebrew is not available since this repository is not notable enough, star this repository to make it available on Homebrew.
103+
Homebrew is not available since this repository is not notable enough, which requires at least 75 stars. Star this repository to make it available on Homebrew.
105104

106105
```shell
107-
❯ curl -sSfL https://github.com/eat-pray-ai/yutu/releases/latest/download/yutu-darwin-$(uname -m) -o /usr/local/bin/yutu
108-
❯ chmod +x /usr/local/bin/yutu
106+
❯ curl -sSfL https://raw.githubusercontent.com/eat-pray-ai/yutu/main/scripts/install.sh | bash
109107
```
110108

111109
### Windows

0 commit comments

Comments
 (0)