diff --git a/README.md b/README.md index 5e311e8..13c4f96 120000 --- a/README.md +++ b/README.md @@ -1 +1 @@ -README_ja.md \ No newline at end of file +README_en.md \ No newline at end of file diff --git a/README_en.md b/README_en.md new file mode 100644 index 0000000..d7ddbff --- /dev/null +++ b/README_en.md @@ -0,0 +1,39 @@ +[Installation](#installation) +| +[Usage](#usage) +*|* +[Japanase(日本語)](README_ja.md) + +*** +[![macOS](https://github.com/kobayasy/printBar/workflows/macOS/badge.svg)](https://github.com/kobayasy/printBar/actions/workflows/build-macos.yml) +[![Linux](https://github.com/kobayasy/printBar/workflows/Linux/badge.svg)](https://github.com/kobayasy/printBar/actions/workflows/build-linux.yml) +*|* +[![SAST](https://github.com/kobayasy/printBar/workflows/SAST/badge.svg)](https://github.com/kobayasy/printBar/actions/workflows/codeql-analysis.yml) + +[printBar] overlays a bar chart on the console output. +It works on any POSIX OS that has Terminfo. + +## Installation +1. Build and installation with the following. +``` +curl -LOJs https://github.com/kobayasy/printBar/releases/download/1.1/printBar-1.1.tar.gz +tar xzf printBar-1.1.tar.gz +cd printBar-1.1 +./configure --prefix=$HOME +make install + +``` + +2. Add ~/bin in the PATH if not included. + +## Usage +1. Do the following to show usage. +``` +printbar --help + +``` + +Execution examples: +printBar + +[printBar]: https://github.com/kobayasy/printBar diff --git a/README_ja.md b/README_ja.md index 2938794..f11a3db 100644 --- a/README_ja.md +++ b/README_ja.md @@ -1,6 +1,9 @@ -[インストール](#インストール) +[インストール](#使い方) | [使い方](#使い方) +*|* +[英語(English)](README_en.md) + *** [![macOS](https://github.com/kobayasy/printBar/workflows/macOS/badge.svg)](https://github.com/kobayasy/printBar/actions/workflows/build-macos.yml) @@ -8,13 +11,11 @@ *|* [![SAST](https://github.com/kobayasy/printBar/workflows/SAST/badge.svg)](https://github.com/kobayasy/printBar/actions/workflows/codeql-analysis.yml) -[printBar] はコンソール出力をバーグラフ表示するコマンドです。 - -## 動作環境 -POSIX準拠のOSならば動作すると思います。 +[printBar] はコンソール出力に棒グラフを重ねて表示します。 +Terminfo が使えるPOSIX準拠のOSならば動作するはずです。 ## インストール -1. 下記コマンドでビルドとインストールを実行します。 +1. 下記コマンドでビルドとインストールをします。 ``` curl -LOJs https://github.com/kobayasy/printBar/releases/download/1.1/printBar-1.1.tar.gz tar xzf printBar-1.1.tar.gz @@ -33,7 +34,7 @@ printbar --help ``` -実行例↓ +実行例: printBar [printBar]: https://github.com/kobayasy/printBar