Skip to content

Commit

Permalink
Merge pull request #32 from nao1215/update-readme-and-more
Browse files Browse the repository at this point in the history
Update readme and more
  • Loading branch information
nao1215 authored Aug 8, 2022
2 parents 373b3e9 + 50f55c6 commit f5e2e85
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v2

- name: Set up Go
uses: actions/setup-go@v2
uses: actions/setup-go@v3
with:
go-version: "1.18"

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
with:
fetch-depth: 0
- name: Setup Go
uses: actions/setup-go@v2
uses: actions/setup-go@v3
with:
go-version: "1.18"
- name: Run GoReleaser
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/unit_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v2

- name: Set up Go
uses: actions/setup-go@v2
uses: actions/setup-go@v3
with:
go-version: "1.18"

Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
# gup - Update binaries installed by "go install"
![demo](./doc/img/demo.gif)

**gup** command update binaries installed by "go install" to the latest version. gup updates all binaries in parallel, so very fast. It also provides subcommands for manipulating binaries under \$GOPATH/bin (\$GOBIN). It is a cross-platform software that runs on Windows, Mac and Linux. [The release page](https://github.com/nao1215/gup/releases) contains packages in .deb, .rpm, and .apk formats.
**gup** command update binaries installed by "go install" to the latest version. gup updates all binaries in parallel, so very fast. It also provides subcommands for manipulating binaries under \$GOPATH/bin (\$GOBIN). It is a cross-platform software that runs on Windows, Mac and Linux.

If you are using oh-my-zsh, then gup has an alias set up. The alias is `gup - git pull --rebase`. Therefore, please make sure that the oh-my-zsh alias is disabled (e.g. $ \gup update).

![sample](./doc/img/sample.png)

Expand All @@ -17,16 +19,15 @@ gup command will notify you on your desktop whether the update was successful or
![warning](./doc/img/notify_warning.png)

# How to install
### Step1. Install golang
gup command only supports installation with `$ go install`. If you does not have the golang development environment installed on your system, please install golang from the [golang official website](https://go.dev/doc/install).

### Step2. Install gup
### Use "go install"
If you does not have the golang development environment installed on your system, please install golang from the [golang official website](https://go.dev/doc/install).
```
$ go install github.com/nao1215/gup@latest
```

If you are using oh-my-zsh, then gup has an alias set up. The alias is `gup - git pull --rebase`. Therefore, please make sure that the oh-my-zsh alias is disabled (e.g. $ \gup update).

### Install from Package or Binary
[The release page](https://github.com/nao1215/gup/releases) contains packages in .deb, .rpm, and .apk formats. gup command uses the go command internally, so the golang installation is required.


# How to use
### Update all binaries
Expand Down
10 changes: 7 additions & 3 deletions doc/ja/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,24 @@

**gup**コマンドは、"go install"でインストールしたバイナリを最新版にアップデートします。gupは、すべてのバイナリを並列にアップデートするので、非常に高速です。\$GOPATH/bin (\$GOBIN) 以下にあるバイナリを操作するためのサブコマンドも提供しています。クロスプラットホームソフトであり、Windows, Mac, Linux で動作します。日本語版のみ、[Zenn](https://zenn.dev/nao1215/articles/aef3fe318848d6)に補足記事があります。

oh-my-zshを使っている場合は、`gup`はエイリアス設定されています。エイリアスは、 `gup - git pull --rebase`です。gupの実行時は、oh-my-zshのエイリアスを使わないでください(例: $ \gup update)

![sample](../img/sample.png)

gupコマンドはアップデートが終わった後、成功したか失敗したかをデスクトップ通知します。
![success](..//img/notify_success.png)
![warning](../img/notify_warning.png)
# インストール方法
### Step1. 前準備
現在は、" $ go install"によるインストールのみをサポートしています。そのため、golangの開発環境をシステムにインストールしていない場合、[golang公式サイト](https://go.dev/doc/install)からgolangをインストールしてください。
### "go install"を用いた場合
golangの開発環境をシステムにインストールしていない場合、[golang公式サイト](https://go.dev/doc/install)からgolangをインストールしてください。

### Step2. インストール
```
$ go install github.com/nao1215/gup@latest
```

### パッケージもしくはバイナリからインストールする場合
[リリースページ](https://github.com/nao1215/gup/releases) には、.deb、.rpm、.apk形式のパッケージがあります。ただし、gupコマンドは内部的にgoコマンドに依存しているため、gokangのインストールが必要です。

# 使用方法
### 全てのバイナリをアップデート
全てのバイナリをアップデートしたい場合は、`$ gup update`を実行してください。
Expand Down

0 comments on commit f5e2e85

Please sign in to comment.