Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WakelessSloth56 committed Mar 15, 2024
1 parent 9f6410d commit 6cbcfb1
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,34 @@
自提交 `9eddaae4` 起加入了更多的新功能。

## 使用

- [网站版](https://hi.auioc.org/BilibiliLocalPlayerH5)
- [单文件版](https://hi.auioc.org/BilibiliLocalPlayerH5/aio.html):使用“另存为……”可保存为单个 HTML 文件到本地离线使用。

两版本功能完全相同。

## 开发

1. 克隆项目到本地
2. 下载 [`CommentCoreLibrary.js`](https://github.com/jabbany/CommentCoreLibrary/raw/19db2962ed0ce637a2b99facdf8634d51bb1b503/dist/CommentCoreLibrary.js)[`ass.js`](https://github.com/weizhenye/ASS/raw/e6a3605a2343655d9ef80bdd7e9fe92f92edca22/dist/ass.js)`src/lib`
3. 运行 `tsc` 指令构建 `public/player.js`
4. 浏览器打开 `public/index.html` 即可使用或调试

注意事项:

- 本项目构建不需要项目级别的 NPM 包
- `build.sh` 脚本用于持续集成自动构建,开发时一般不需要使用,在本地使用可能会破坏项目结构!

## 致谢

- [PCC-Studio](https://www.pccstudio.com):编写原始项目
- [AUIOC](https://www.auioc.org):技术支持
- [CommentCoreLibrary](https://github.com/jabbany/CommentCoreLibrary):弹幕支持
- [ASS.JS](https://github.com/weizhenye/ASS):字幕支持

## 许可证

BilibiliLocalPlayerH5 采用 **GNU Affero通用公共许可证 v3.0** 授权。

完整许可文件参见 [LICENSE](/LICENSE)

0 comments on commit 6cbcfb1

Please sign in to comment.