Skip to content

Commit

Permalink
Added README in english.
Browse files Browse the repository at this point in the history
  • Loading branch information
kobayasy committed Feb 15, 2024
1 parent dc71e93 commit 1d32c86
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
39 changes: 39 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
@@ -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:
<img src="printBar.png" alt="printBar"/>

[printBar]: https://github.com/kobayasy/printBar
15 changes: 8 additions & 7 deletions README_ja.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
[インストール](#インストール)
[インストール](#使い方)
|
[使い方](#使い方)
*|*
[英語(English)](README_en.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] はコンソール出力をバーグラフ表示するコマンドです。

## 動作環境
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
Expand All @@ -33,7 +34,7 @@ printbar --help
```

実行例
実行例:
<img src="printBar.png" alt="printBar"/>

[printBar]: https://github.com/kobayasy/printBar

0 comments on commit 1d32c86

Please sign in to comment.