https://github.com/yappy/dollskit
yappy家の管理プログラム
https://github.com/yappy/dollskit
raspberry-pi raspberrypi rust shell-script
Last synced: 12 days ago
JSON representation
yappy家の管理プログラム
- Host: GitHub
- URL: https://github.com/yappy/dollskit
- Owner: yappy
- License: mit
- Created: 2016-08-05T13:46:56.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-12-24T09:18:45.000Z (about 2 months ago)
- Last Synced: 2025-12-24T09:53:42.313Z (about 2 months ago)
- Topics: raspberry-pi, raspberrypi, rust, shell-script
- Language: Rust
- Homepage:
- Size: 14.7 MB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DollsKit
Github Actions:
[](https://github.com/yappy/DollsKit/actions/workflows/rust.yml)
[](https://github.com/yappy/DollsKit/actions/workflows/doc.yml)
yappy家の管理プログラム
## ドキュメント
GitHub Pages:
ドキュメントのソースは `docs/` 以下: [docs/index.md](./docs/index.md)
## ソースの入手
```sh
git clone
```
## ビルド
環境の整った人形、または PC の中で
```sh
cd shanghai
cargo build --release
# or
cargo b -r
# 以下は debug build となる
cargo build
```
Stable 版の Rust 環境があればビルドできるはず。
### リンクの高速化
[rust_tools.md](./docs/note/rust_tools.md) を参照。
## 管理プログラムの実行開始
### 仮実行
```sh
cargo run --release
# or
cargo r -r
```
### 設定
起動には設定ファイルが必要です。
初回起動時は設定ファイルが存在しないためエラーになりますが、
デフォルト設定ファイルが生成されるのでそれをコピーして作成してください。
ほぼすべての機能はデフォルトでは無効になっています。
存在しないキーはデフォルトファイルの内容が使われます。
```sh
cp config_default.toml config.toml
```
### フォント
※Twitter bot 向けの機能なので現在は有効にしても動作しません。
デフォルト設定で指定されているフォントファイルは以下でインストールできます。
```sh
sudo apt install fonts-ipafont
```
### 本実行
```sh
cargo run --release
# or
cargo r -r
```
### daemon として実行
`--daemon` オプション付きで実行します。
```sh
cargo run --release -- --daemon
or
cargo r -r -- --daemon
```
ただし、`--daemon` なしでもよいので一度実行すると `exec.sh`, `kill.sh` が
生成されるので、そちらを実行する方が便利です。
```sh
./exec.sh
./kill.sh
```
### シグナル
* SIGINT
* SIGTERM
* プログラムを終了します。
* SIGHUP
* (プロセスを終了せずに) 再起動します。設定やリソースファイルのリロードに使えます。
* SIGUSR1
* ログをフラッシュします。
ディスク (SD Card) の寿命対策のため、これを行わないと最新のログがファイルに
反映されません。
## システム起動時に自動起動
一度実行すると `cron.txt` ができます。
```sh
crontab < cron.txt
```
## 設定ファイル (config.toml) のヘルプ
ドキュメントの sys::config::Config にあります。
## テストのビルドと実行
```sh
cargo test
```
## ドキュメントのビルド
```sh
cargo doc --no-deps --document-private-items
```
## CI
GitHub Actions で自動ビルドを行っています。
`.github/workflows/` 以下を参照。
### 自動ビルド
push および pull request 時に debug/release ビルドおよびテストを行います。
### ドキュメントの自動更新
`doc` ブランチの `docs/` ディレクトリが GitHub Pages で公開されています。
`main` ブランチに変更が push されると自動で `doc` ブランチを更新します。
1. `doc` ブランチをチェックアウト
1. `doc` ブランチに `main` ブランチをマージ
1. `cargo doc` で Rust ドキュメントを自動生成
1. `docs/` 以下を更新して commit
1. push