Skip to content

Commit

Permalink
README: use "[[ ! ${BLE_VERSION-} ]] || ble-attach"
Browse files Browse the repository at this point in the history
* README: remove unecessary "INSDIR_LICENSE"
* README: add an example `_package.bash` in Quick instruction
* README: change "[[ ${BLE_VERSION-} ]] &&" to "[[ ! ${BLE_VERSION-} ]] ||"
* README: change "tar ball" to "tarball"
* README: mention the link to the nightly release page
  • Loading branch information
akinomyoga committed Aug 25, 2024
1 parent 0aa66b2 commit ed11901
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jobs:
# Add the following line near the top of ~/.bashrc
[[ $- == *i* ]] && source ~/.local/share/blesh/ble.sh --attach=none
# Add the following line at the end of ~/.bashrc
[[ ${BLE_VERSION-} ]] && ble-attach
[[ ! ${BLE_VERSION-} ]] || ble-attach
# Note: After installation, directory ble-${{ env.blesh_build_pkgver }} can be removed.
```
check:
Expand Down
27 changes: 18 additions & 9 deletions README-ja_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@
## 簡単設定

<!-- 但し、macOS では附属の `/usr/bin/awk` (awk-32 以降) でマルチバイト文字セットの問題があるため、`gawk`, `nawk`, または `mawk` を別途インストールする必要があるかもしれません。 -->
`ble.sh` を取得するには主に2つの方法があります: `git` を用いてソースを取得しビルドする方法と `curl` または `wget` を用いて nightly ビルドをダウンロードする方法です。
詳細は、試用またはインストールに関しては [節1.1](#get-from-source)[節1.2](#get-from-tarball) を、
`~/.bashrc` の設定に関しては [節1.3](#set-up-bashrc) を御覧ください。
`ble.sh` を取得するには主に2つの方法があります: `git` を用いてソースを取得しビルドする方法と、
`curl` または `wget` を用いて [nightly ビルド](https://github.com/akinomyoga/ble.sh/releases/tag/nightly)をダウンロードする方法です。
試用とインストール方法の詳細に関しては [節1.1](#get-from-source)[節1.2](#get-from-tarball) を、
`~/.bashrc` の設定の詳細に関しては [節1.3](#set-up-bashrc) を御覧ください。

> [!NOTE]
> `fzf``ble.sh` と組み合わせてお使いの場合は [節2.8](#fzf-integration) を必ず御覧ください。
Expand Down Expand Up @@ -118,7 +119,7 @@ bash /path/to/ble.sh --update
<details><summary><b><code>ble.sh</code> のパッケージ作成</b></summary>

`ble.sh` は単にシェルスクリプトの集合ですので環境に依存せずにお使いいただけます (いわゆる "`noarch`") ので、
単にリリースページからビルド済みの tar ボールをダウンロードし中身を `/tmp/blesh-package/usr/local` など所定の位置に配置するだけで問題ありません。
単にリリースページからビルド済みの tarball をダウンロードし中身を `/tmp/blesh-package/usr/local` など所定の位置に配置するだけで問題ありません。
それでも何らかの理由により自前でビルドする必要がある場合には以下のコマンドをお使いください。
ビルドの為には git リポジトリ (`.git`) が必要になることにご注意ください。

Expand All @@ -135,6 +136,15 @@ make -C ble.sh install DESTDIR=/tmp/blesh-package PREFIX=/usr/local
スクリプトファイル `_package.bash``${prefix}/share/blesh/lib/_package.bash` に配置することで、
`ble-update` で用いるパッケージ更新方法を指定することができます。
詳細については節 [`_package.bash`](#_packagebash) を御参照ください。

```bash
# ${prefix}/share/blesh/lib/_package.bash

_ble_base_package_type=XXX
function ble/base/package:XXX/update {
update-the-package-in-a-proper-way
}
```
</details>

## 機能概要
Expand Down Expand Up @@ -314,8 +324,7 @@ make install DESTDIR="$build" PREFIX="$prefix" \
INSDIR_DOC="$build/$prefix/share/blesh/doc"
# パッケージ作成 - 例4
make install USE_DOC=no DESTDIR="$build" PREFIX="$prefix" \
INSDIR_LICENSE="$build/$prefix/share/blesh"
make install USE_DOC=no DESTDIR="$build" PREFIX="$prefix"
```

`INSDIR` の代わりに Make 変数 `DESTDIR` または `PREFIX` が指定されている時、
Expand Down Expand Up @@ -346,9 +355,9 @@ function ble/base/package:XXX/update {
それ以外の場合には更新処理が中断されます。この場合、シェル関数が状況を説明するメッセージを出力するようにして下さい。
具体例として `AUR` パッケージの [`_package.bash`](https://aur.archlinux.org/cgit/aur.git/tree/blesh-update.sh?h=blesh-git) も参考にしていただければ幸いです。

## 1.2 tar ボールのダウンロード<sup><a id="get-from-tarball" href="#get-from-tarball">†</a></sup>
## 1.2 tarball のダウンロード<sup><a id="get-from-tarball" href="#get-from-tarball">†</a></sup>

GitHub Releases から `ble.sh`tar ボールをダウンロードすることもできます
GitHub Releases から `ble.sh`tarball をダウンロードすることもできます
ダウンロード・試用・インストールの方法については各リリースページの説明を御覧ください。
現在、安定版は開発版に比べてかなり古いので様々な機能が欠けていることにご注意下さい。

Expand All @@ -371,7 +380,7 @@ GitHub Releases から `ble.sh` の tar ボールをダウンロードするこ
# 間に通常の bashrc の内容を既述します。

# .bashrc の末端近くに以下を追加して下さい。
[[ ${BLE_VERSION-} ]] && ble-attach
[[ ! ${BLE_VERSION-} ]] || ble-attach
```

`source /path/to/ble.sh` 及び `ble-attach` を呼び出す時は、
Expand Down
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@ This script is provided under the [**BSD License**](LICENSE.md) (3-clause BSD li
## Quick instructions

<!-- In macOS, you might additionally need to install `gawk`, `nawk`, or `mawk` since macOS `/usr/bin/awk` (awk-32 and later) seems to have a problem with some multibyte charsets. -->
There are two ways to get `ble.sh`: to download and build `ble.sh` using `git`, or to download the nightly build using `curl` or `wget`.
For the detailed descriptions, see [Sec 1.1](#get-from-source) and [Sec 1.2](#get-from-tarball) for trial/installation,
and [Sec 1.3](#set-up-bashrc) for the setup of your `~/.bashrc`.
There are two ways to get `ble.sh`: to get the source using `git` and build
`ble.sh`, or to download the [nightly build](https://github.com/akinomyoga/ble.sh/releases/tag/nightly) using `curl` or `wget`.
See [Sec 1.1](#get-from-source) and [Sec 1.2](#get-from-tarball) for the details of trial and installation.
See [Sec 1.3](#set-up-bashrc) for the details of the setup of your `~/.bashrc`.

> [!NOTE]
> If you want to **use fzf with `ble.sh`**, you need to check [Sec
> 2.8](#fzf-integration).
<details open><summary><b>Download and generate <code>ble.sh</code> using <code>git</code></b></summary>
<details open><summary><b>Download source using <code>git</code> and make <code>ble.sh</code></b></summary>

This requires the commands `git`, `make` (GNU make), and `gawk` (GNU awk)<sup><a href="#discl-pronun">†3</a></sup>.
In the following, please replace `make` with `gmake` if your system provides GNU make as `gmake` (such as in BSD).
Expand Down Expand Up @@ -134,6 +135,15 @@ files, and the documentation files, please also check the later sections
If you want to tell `ble.sh` the way to update the package for `ble-update`,
you can place `_package.bash` at `${prefix}/share/blesh/lib/_package.bash`.
Please check [`_package.bash`](#_packagebash) for the details.

```bash
# ${prefix}/share/blesh/lib/_package.bash

_ble_base_package_type=XXX
function ble/base/package:XXX/update {
update-the-package-in-a-proper-way
}
```
</details>

## Features
Expand Down Expand Up @@ -355,8 +365,7 @@ make install DESTDIR="$build" PREFIX="$prefix" \
INSDIR_DOC="$build/$prefix/share/blesh/doc"

# PACKAGE - Example 4
make install USE_DOC=no DESTDIR="$build" PREFIX="$prefix" \
INSDIR_LICENSE="$build/$prefix/share/blesh"
make install USE_DOC=no DESTDIR="$build" PREFIX="$prefix"
```

If make variable `DESTDIR` or `PREFIX` is specified instead of `INSDIR`, the
Expand Down Expand Up @@ -389,9 +398,9 @@ When the shell function returns exit status 125, the default `ble.sh` update pro
Otherwise, the updating procedure is canceled, where any message explaining situation should be output by the shell function.
An example `_package.bash` for `AUR` can be found [here](https://aur.archlinux.org/cgit/aur.git/tree/blesh-update.sh?h=blesh-git).

## 1.2 Download a tar ball<sup><a id="get-from-tarball" href="#get-from-tarball">†</a></sup>
## 1.2 Download a tarball<sup><a id="get-from-tarball" href="#get-from-tarball">†</a></sup>

You can also download a tar ball of `ble.sh` from GitHub releases.
You can also download a tarball of `ble.sh` from GitHub releases.
See each release page for the description of downloading, trial and installation.
Many features are unavailable in the stable versions since they are significantly old compared to the devel version.

Expand All @@ -414,7 +423,7 @@ but a more reliable way is to add the following codes to your `.bashrc` file:
# your bashrc settings come here...

# Add this line at the end of .bashrc:
[[ ${BLE_VERSION-} ]] && ble-attach
[[ ! ${BLE_VERSION-} ]] || ble-attach
```

Basically, when `source /path/to/ble.sh` and `ble-attach` are performed,
Expand Down
2 changes: 1 addition & 1 deletion blerc.template
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
## # Your bashrc contents should come between the two lines.
##
## # Please put the following line in the end of .bashrc
## [[ ${BLE_VERSION-} ]] && ble-attach
## [[ ! ${BLE_VERSION-} ]] || ble-attach
## ```
##

Expand Down
5 changes: 3 additions & 2 deletions docs/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@
- docs(README): add sabbrev example for named directories `#D2115` a9a21a0e
- docs(README): note `bleopt prompt_command_changes_layout=1` `#D2196` 208eaa9d
- docs(README): move disclaimers to a later section `#D2250` ad6f58b7
- README: use `[[ ! ${BLE_VERSION-} ]] || ble-attach` `#D2264` xxxxxxx

## Test

Expand Down Expand Up @@ -997,7 +998,7 @@
- decode: use `BRE` instead of `ERE` for `POSIX sed` (reported by dylankb) `#D1283` 2184739
- decode: fix strange behaviors after `fzf` (convert <kbd>DEL</kbd> to <kbd>C-?</kbd>) `#D1281` 744c8e8
- edit: work around Bash rebinding on `TERM` change `#D1287` ac7ab55 7a99bf3
- term: work around terminfo/termcap entry collisions in `tput` (reported by killermoehre) `#D1289` f8c54ef
- term: work around terminfo/termcap entry collisions in `tput` (reported by killermoehre) `#D1289` f8c54ef
- complete: clear menu on discard-line (reported by animecyc) `#D1290` fb794b3 `#D1315` 99880ef
- vi (vi-command/nth-column): fix a bug in arithmetic expansion (reported by andychu) `#D1292` da6cc47
- complete: fix a bug that insert-word does not for with ambiguous candidates `#D1295` 2f9a000
Expand Down Expand Up @@ -2671,7 +2672,7 @@
* ble-syntax/completion-context: 一部の補完文脈を file から argument に変更。
* complete.sh: complete -p 設定に基づく補完。
* ble-complete/source/argument: 追加

## 2015-11-22
* ble-syntax.sh: bash 文法関連の関数名整理。
* ble-decode.sh (ble-bind): error message に . を追加。古いコメントを削除。
Expand Down
11 changes: 11 additions & 0 deletions note.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7373,6 +7373,17 @@ bash_tips

2024-08-25

* README: ble-attach の条件を [[ ! ${BLE_VERSION-} ]] || ble-attach に変更 [#D2264]

現在の方法 [[ ${BLE_VERSION-} ]] && ble-attach だと ble.sh をロードしていな
い時の最初のステータスが失敗になる。特にプロンプトで最後の終了ステータスを
表示する物では最初のステータスが失敗になるのは変である。他の方法として if
[[ ${BLE_VERSION-} ]]; then ble-attach; fi と記述させる手もあるが、長いしこ
の様に指示すると [[ ${BLE_VERSION-} ]] && ble-attach に縮めてしまう人もいる
気がするので、明示的に短い版を提示するのが良い。

その他の色々の README の指示も含める事にする。

* color: 変数の色が分かりにくい。unset 変数の色と値を持つ変数の色が近すぎる [#D2263]
Ref: #D2248, #D2258

Expand Down

0 comments on commit ed11901

Please sign in to comment.