Update README.md
This commit is contained in:
49
README.md
49
README.md
@@ -3,51 +3,52 @@
|
|||||||
TauClockは、ローカル/UTC時計、アラーム、カウントダウンタイマー、ストップウォッチを1つのネイティブウィンドウにまとめたTauriアプリケーションです。キーボード操作を前提に設計しており、記録したアラームやラップはローカルストレージに保存されます。
|
TauClockは、ローカル/UTC時計、アラーム、カウントダウンタイマー、ストップウォッチを1つのネイティブウィンドウにまとめたTauriアプリケーションです。キーボード操作を前提に設計しており、記録したアラームやラップはローカルストレージに保存されます。
|
||||||
|
|
||||||
## 主な特徴
|
## 主な特徴
|
||||||
|
|
||||||
- リアルタイムなローカル・UTC時計の並列表示
|
- リアルタイムなローカル・UTC時計の並列表示
|
||||||
- 任意ラベル付きの繰り返しアラーム(オフラインでも保持)
|
- 任意ラベル付きの繰り返しアラーム
|
||||||
- 柔軟な入力形式に対応したカウントダウンタイマー(`5m30s`, `1:15`, `90` など)
|
- 柔軟な入力形式に対応したカウントダウンタイマー(`5m30s`, `1:15`, `90` など)
|
||||||
- ラップ記録つきストップウォッチと履歴リスト
|
- ラップ記録つきストップウォッチと履歴リスト
|
||||||
- キーボードショートカットと画面内に表示できるチートシート
|
- キーボードショートカットと画面内に表示できるチートシート
|
||||||
- Tauri + Rust製の軽量クロスプラットフォームバイナリ
|
- Tauri + Rust製の軽量クロスプラットフォームバイナリ
|
||||||
|
|
||||||
## キーボードショートカット
|
## キーボードショートカット
|
||||||
| キー | 動作 |
|
|
||||||
| --- | --- |
|
| キー | 動作 |
|
||||||
| `H` | ショートカット一覧を開閉 |
|
| ----- | ------------------------------------------ |
|
||||||
| `A` | アラームの時刻入力欄にフォーカス |
|
| `H` | ショートカット一覧を開閉 |
|
||||||
| `N` | アラームを追加 |
|
| `A` | アラームの時刻入力欄にフォーカス |
|
||||||
| `T` | タイマーの時間入力欄にフォーカス |
|
| `N` | アラームを追加 |
|
||||||
| `G` | タイマー開始/一時停止 |
|
| `T` | タイマーの時間入力欄にフォーカス |
|
||||||
| `R` | タイマーをリセット |
|
| `G` | タイマー開始/一時停止 |
|
||||||
| `W` | ストップウォッチ開始/停止 |
|
| `R` | タイマーをリセット |
|
||||||
| `L` | ラップを追加 |
|
| `W` | ストップウォッチ開始/停止 |
|
||||||
| `P` | ストップウォッチをリセット |
|
| `L` | ラップを追加 |
|
||||||
|
| `P` | ストップウォッチをリセット |
|
||||||
| `Esc` | 入力フォーカス解除 or オーバーレイを閉じる |
|
| `Esc` | 入力フォーカス解除 or オーバーレイを閉じる |
|
||||||
|
|
||||||
## ディレクトリ構成
|
## ディレクトリ構成
|
||||||
|
|
||||||
- `src/` – フロントエンド(HTML/CSS/JavaScript)。`main.js` には各ウィジェットのロジックと詳しいコメントがあります。
|
- `src/` – フロントエンド(HTML/CSS/JavaScript)。`main.js` には各ウィジェットのロジックと詳しいコメントがあります。
|
||||||
- `src-tauri/` – Rust製バックエンドおよびTauri設定。`lib.rs` にプラグインやコマンドの初期化がまとまっています。
|
- `src-tauri/` – Rust製バックエンドおよびTauri設定。`lib.rs` にプラグインやコマンドの初期化がまとまっています。
|
||||||
- `src-tauri/tauri.conf.json` – アプリの識別子やアイコン設定。
|
- `src-tauri/tauri.conf.json` – アプリの識別子やアイコン設定。
|
||||||
|
|
||||||
## 開発環境
|
## 開発環境
|
||||||
|
|
||||||
### 事前準備
|
### 事前準備
|
||||||
- [Node.js](https://nodejs.org/) 18 以上
|
|
||||||
- npm または好きなパッケージマネージャ
|
|
||||||
- [Rust](https://www.rust-lang.org/tools/install) と `cargo`
|
- [Rust](https://www.rust-lang.org/tools/install) と `cargo`
|
||||||
- Tauriの推奨コンパイラ/プラットフォーム依存ツール([公式ドキュメント](https://tauri.app/start/prerequisites/)を参照)
|
- Tauriの推奨コンパイラ/プラットフォーム依存ツール([公式ドキュメント](https://tauri.app/start/prerequisites/)を参照)
|
||||||
|
|
||||||
### セットアップ
|
### ローカルで起動
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
cargo tauri dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### ローカルで起動
|
|
||||||
```bash
|
|
||||||
npm run tauri dev
|
|
||||||
```
|
|
||||||
ホットリロード付きでウィンドウが立ち上がり、UIから各機能を試せます。
|
ホットリロード付きでウィンドウが立ち上がり、UIから各機能を試せます。
|
||||||
|
|
||||||
### ログレベルの切り替え
|
### ログレベルの切り替え
|
||||||
|
|
||||||
- フロントエンド: 既定で `info` レベルのみ表示します。`localStorage.setItem('tauclock:log-level', 'debug')` か
|
- フロントエンド: 既定で `info` レベルのみ表示します。`localStorage.setItem('tauclock:log-level', 'debug')` か
|
||||||
`?logLevel=debug` をクエリに付けると詳細ログが有効になります。
|
`?logLevel=debug` をクエリに付けると詳細ログが有効になります。
|
||||||
- バックエンド: `TAUCLOCK_LOG_LEVEL`(または互換の `TAUCLOCK_LOG`)環境変数で制御できます。
|
- バックエンド: `TAUCLOCK_LOG_LEVEL`(または互換の `TAUCLOCK_LOG`)環境変数で制御できます。
|
||||||
@@ -55,13 +56,13 @@ npm run tauri dev
|
|||||||
未設定の場合はデバッグビルドが `debug`、リリースビルドが `info` になります。
|
未設定の場合はデバッグビルドが `debug`、リリースビルドが `info` になります。
|
||||||
|
|
||||||
### ビルド
|
### ビルド
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run tauri build
|
cargo tauri build
|
||||||
```
|
```
|
||||||
|
|
||||||
`src-tauri/target/release/` 以下に配布用バイナリが生成されます。
|
`src-tauri/target/release/` 以下に配布用バイナリが生成されます。
|
||||||
|
|
||||||
## コントリビュート
|
|
||||||
Issue/PRは歓迎です。バグ報告の際は実行環境・手順を明記してください。新機能追加時は `src/main.js` にあるコメントスタイルに合わせてドキュメントも更新してください。
|
|
||||||
|
|
||||||
## ライセンス
|
## ライセンス
|
||||||
|
|
||||||
MIT License. 詳細は `LICENSE` を参照してください。
|
MIT License. 詳細は `LICENSE` を参照してください。
|
||||||
|
|||||||
Reference in New Issue
Block a user