Skip to content

Commit

Permalink
📝 Update install section and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
OpenWaygate committed Dec 30, 2024
1 parent 3f1b001 commit 5d60088
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
20 changes: 19 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,22 @@ yutu is a cli tool built using the [cobra](https://github.com/spf13/cobra). Feel
- Commit messages should follow the [gitmoji](https://gitmoji.dev) convention.
- Follow the existing naming and project structure.

**Tests are especially welcomed**, as they are currently missing from the project.
Here are some commands which may useful.

```shell
# upgrade all dependencies
❯ go get -u ./...

# run tests
## unit tests
❯ go test ./...
## verify binary commands, detect shorthands conflicts, etc.
❯ ./scripts/command-test.sh

# build the binary
## install goreleaser: https://goreleaser.com/install
❯ GITHUB_REPOSITORY=eat-pray-ai/yutu goreleaser build --clean --auto-snapshot

# script to install yutu
❯ ./scripts/install.sh
```
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,17 +95,15 @@ There are two actions available for yutu, one is for general purpose and the oth
### Linux

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

### macOS

Homebrew is not available since this repository is not notable enough, star this repository to make it available on Homebrew.
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.

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

### Windows
Expand Down

0 comments on commit 5d60088

Please sign in to comment.