Skip to content

Commit

Permalink
feat: add jp README
Browse files Browse the repository at this point in the history
  • Loading branch information
yacchi committed Oct 25, 2023
1 parent 981b4fe commit 2f12c4d
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 4 deletions.
82 changes: 82 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# asdf-make

[![Build](https://github.com/yacchi/asdf-make/actions/workflows/build.yml/badge.svg)](https://github.com/yacchi/asdf-make/actions/workflows/build.yml)
[![Lint](https://github.com/yacchi/asdf-make/actions/workflows/lint.yml/badge.svg)](https://github.com/yacchi/asdf-make/actions/workflows/lint.yml)

[asdf version manager](https://asdf-vm.com)[GNU Make](https://www.gnu.org/software/make/)プラグイン。

# 依存関係

- `bash`, `curl`, `tar`: 汎用のPOSIXユーティリティ
- Cコンパイラあるいはビルド環境(例: build-essentials)

## macOS

- [GnuPG](http://www.gnupg.org) - `brew install gpg`
- Xcodeコマンドラインツール - `xcode-select --install`

## Linux (Debian)

- [GnuPG](http://www.gnupg.org) - `apt-get install gpg`
- [GCC](http://gcc.gnu.org/) - `apt-get install build-essentials`

# インストール

## プラグイン

```shell
asdf plugin add make
# または
asdf plugin add make https://github.com/yacchi/asdf-make.git
```

## GPG公開キーのインポート

`GPG verification error`が発生した場合、キーのインポートが必要です。以下のコマンドを使用してキーをインポートできます。

___キーの追加は自己責任で行ってください。詳細については、GNU Makeプロジェクトのサイトをご参照ください。___

- https://savannah.gnu.org/projects/make
- https://make.mad-scientist.net/
- https://www.gnu.org/software/security/security.html

```shell
gpg --recv-keys 96B047156338B6D4 80CB727A20C79BB2
# または
gpg --keyserver keys.gnupg.net --recv-keys 96B047156338B6D4 80CB727A20C79BB2
# または
gpg --keyserver keyserver.ubuntu.com --recv-keys 96B047156338B6D4 80CB727A20C79BB2
```

## make

```shell
# すべてのインストール可能なバージョンを表示
asdf list-all make
# 特定のバージョンをインストール
asdf install make latest
# グローバルにバージョンを設定(~/ .tool-versionsファイルで)
asdf global make latest
# これでmakeコマンドが利用可能になります
make --version
```

# 設定

[asdf](https://github.com/asdf-vm/asdf)のREADMEを参照し、インストールとバージョンの管理方法についての詳細な指示を確認してください。GNU
Makeを`asdf install`を使ってインストールする際、以下の環境変数でカスタム設定オプションを渡すことができます:

| 環境変数 | デフォルト値 | 他の値 | 説明 |
|-----------------------|-----------------|-----|----------|
| MAKE_CHECK_SIGNATURES | strict | no | GPG署名の検証 |
| MAKE_PRINT_BUILD_LOG | no | yes | ビルドログの表示 |
| MAKE_BUILD_OPTIONS | --with-guile=no | | ビルドオプション |

# 貢献

どんな貢献も歓迎します! [貢献ガイド](contributing.md)を参照してください。

# ライセンス

[LICENSE](https://github.com/yacchi/asdf-make/blob/main/LICENSE)
を参照してください。© [Yasunori Fujie](https://github.com/yacchi/)
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,30 @@
# Dependencies

- `bash`, `curl`, `tar`: generic POSIX utilities.
- A C compiler
- A C compiler or build environment (e.g. build-essentials).

## macOS

* [GnuPG](http://www.gnupg.org) - `brew install gpg`
* Xcode Command line tools - `xcode-select --install`

## Linux (Debian)

* [GnuPG](http://www.gnupg.org) - `apt-get install gpg`
* [GCC](http://gcc.gnu.org/) - `apt-get install gcc`

# Install

## Plugin

```shell
asdf plugin add make
# or
asdf plugin add make https://github.com/yacchi/asdf-make.git
```

## Import GPG public key

If a `GPG verification error` occurs, key import is required.
The following commands can be used to import keys.

Expand All @@ -43,6 +47,7 @@ gpg --keyserver keyserver.ubuntu.com --recv-keys 96B047156338B6D4 80CB727A20C79B
```

## make

```shell
# Show all installable versions
asdf list-all make
Expand All @@ -58,16 +63,22 @@ make --version
```

# Use

Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
install & manage versions.

When installing GNU Make using `asdf install`, you can pass custom configure options with the following env vars:
* `MAKE_CHECK_SIGNATURES` - `strict` is default. Other values are `no`.
* `MAKE_PRINT_BUILD_LOG` - `no` is default. Other value are `yes`.
* `MAKE_BUILD_OPTIONS` - `--with-guile=no` is default.

| Environment Variable | Default Value | Other Values | Description |
|-----------------------|-----------------|--------------|----------------------------|
| MAKE_CHECK_SIGNATURES | strict | no | GPG signature verification |
| MAKE_PRINT_BUILD_LOG | no | yes | Display build log |
| MAKE_BUILD_OPTIONS | --with-guile=no | | Build options |

# Contributing

Contributions of any kind welcome! See the [contributing guide](contributing.md).

# License

See [LICENSE](https://github.com/yacchi/asdf-make/blob/main/LICENSE) © [Yasunori Fujie](https://github.com/yacchi/)

0 comments on commit 2f12c4d

Please sign in to comment.