anitty 0.1.0

Anime character animation rendering for terminals
Documentation
# 开发与发布

## 构建

使用支持 Rust 2024 edition 的工具链和 Cargo。项目暂未承诺经过验证的最低 Rust 版本;
依赖也可能要求较新的工具链。启用 `spine-38` 另需 C 编译器,默认 Sprite 构建不需要 C 工具链。

```sh
cargo build
cargo build --release --features spine-38
cargo doc --no-deps --features spine-38 --open
```

`spine` 是 `spine-38` 的别名。Rust 依赖由 Cargo 获取;固定版本的 Spine C 源码随包提供。
软件渲染和编码应使用 release 构建评估性能,debug 开销不代表实际播放成本。

## 检查

日常修改只运行相关测试。发布前可完整检查默认与可选功能:

```sh
cargo fmt --check
cargo test
cargo test --features spine-38
cargo build --release --examples --features spine-38
```

`tests/fixtures/` 提供随仓库分发的微型素材,测试不依赖外部角色资源。
`tests/fixtures/spine/generate.py` 可重新生成 Spine fixture,需要 Python 和 Pillow;
普通构建及运行测试不需要它们。

协议编码测试不能代替目标终端的实际播放验证。支持状态表示探测证据,
不保证每种终端都实现了相同的替换、清理或透明效果。

## 打包与首版发布

首个版本为 `0.1.0`,发布到 crates.io。下列检查在本地生成 crate 包,不上传:

```sh
cargo package --list
cargo package
cargo package --features spine-38
```

在待发布改动尚未提交时,可为上述命令增加 `--allow-dirty`;正式发布应使用已审核的提交。
检查包中包含 README、正式文档、源代码、示例、测试素材,以及 Spine runtime 的源码与独立许可证。
使用者自己的角色资源不随包分发。`Cargo.toml` 的 `include` 明确限定发布内容。

`cargo package` 会在解包目录验证构建;可选 Spine 功能也需要单独验证,避免遗漏 C 源码或头文件。
发布前确认包名可用,并在本机配置 crates.io 发布凭据;本文不表示该版本已经上传。
实际发布使用 `cargo publish --registry crates-io`,再以 `v0.1.0` tag 标记发布提交。
`Cargo.toml` 已设置 GitHub 仓库和 docs.rs 文档地址。

只需发布一次:`spine-38` 是同一个 crate 的可选 feature,不需要单独发布 Spine 版本。
使用者通过 `anitty = { version = "0.1.0", features = ["spine-38"] }` 启用;
`build.rs` 会在使用者机器上编译随包提供的 C runtime 并静态链接,因此仍需 C 编译器,
无需另行安装或部署 spine-c 动态库。默认不启用该 feature,三个终端 backend 均默认可用。

默认发布的是 Rust crate,没有安装型 CLI、公开 C ABI 或可供其他语言直接调用的动态库。
`examples/` 是源码示例。docs.rs 配置启用 `spine-38`,以展示全部现有公开类型。

## 许可证

项目代码使用根目录的 [MIT License](../LICENSE)。
可选 Spine runtime 的许可证位于 [vendor/spine-c/3.8/LICENSE](../vendor/spine-c/3.8/LICENSE),
上游版本与本地修正记录位于 [UPSTREAM](../vendor/spine-c/3.8/UPSTREAM)。
这部分源码不因随 crate 分发而变成 MIT;请分别阅读和遵守相关许可。
第三方 Rust 依赖与使用者提供的动画素材也保留各自的许可。