Update README

BililiveRecorder · Jun 11, 2022 · b7a9f32 · b7a9f32
1 parent 6cf5330
commit b7a9f32
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 33 deletions.
diff --git a/.github/assets/logo.svg b/.github/assets/logo.svg
diff --git a/README.md b/README.md
@@ -1,13 +1,18 @@
-# BiliBili Stream Recorder B站录播姬
+<div style="text-align:center">
+<img width="20%" src=".github/assets/logo.svg">
 
-[![Build and Test](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml/badge.svg)](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml)
+# B站录播姬
+
+[![Build and Test](https://github.com/BililiveRecorder/BililiveRecorder/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/BililiveRecorder/BililiveRecorder/actions/workflows/build.yml)
 [![Version](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=Version)](#)
 [![License](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg)](#)
 [![Crowdin](https://badges.crowdin.net/bililiverecorder/localized.svg)](https://crowdin.com/project/bililiverecorder)
 
+</div>
+
 [简体中文 README | Simplified Chinese](README_CN.md)
 
-GitHub is a global platform, and theoretically, everyone should use English. But since this project is mostly meant for Chinese user and rely on a Chinese website [BiliBili](https://live.bilibili.com) ([_wikipedia_](https://en.wikipedia.org/wiki/Bilibili)), all code comments are in Chinese. This README file will always use English so people like _you_ can understand what is this, and perhaps make some use out of it.
+GitHub is a global platform, and theoretically, everyone should use English. But since this project is mostly meant for Chinese user and rely on a Chinese website [BiliBili](https://live.bilibili.com) ([_wikipedia_](https://en.wikipedia.org/wiki/Bilibili)), most things related to this project like code comments, documentations and other related repositories are written in Chinese. This README file will always use English so people like _you_ can understand what is this, and perhaps make some use out of it.
 
 Software UI is available in
 
@@ -16,9 +21,18 @@ Software UI is available in
 - 日本語
 - English
 
-## Install & Use
+## Installation
+
+See [rec.danmuji.org](https://rec.danmuji.org) (in Chinese) for Windows installer with auto update.
+
+Alernatively, you can download from [releases](https://github.com/BililiveRecorder/BililiveRecorder/releases) page.  
+The zip file avaiable at the releases page does not have auto update enabled. You are welcome to watch this repository for releases. (Click the "Watch" dropdown menu, then "Custom", and check the "Releases" checkbox).
 
-See [rec.danmuji.org](https://rec.danmuji.org) (in Chinese)
+Binary files of the command line version are available for Linux, macOS, and Windows at [releases](https://github.com/BililiveRecorder/BililiveRecorder/releases).
+
+Docker images are available at [Docker Hub `bililive/recorder`](https://hub.docker.com/r/bililive/recorder) or [`ghcr.io/bililiverecorder/bililiverecorder`](https://github.com/bililiverecorder/BililiveRecorder/pkgs/container/bililiverecorder).
+
+Step by step installation guides are avaiable at [rec.danmuji.org/user/install](https://rec.danmuji.org/user/install) (in Chinese).
 
 ## Feature
 
@@ -33,21 +47,58 @@ See [rec.danmuji.org](https://rec.danmuji.org) (in Chinese)
 <sup>1</sup>: Only unprocessed flv file downloaded directly from stream servers can be fixed. If the file is downloaded or processed by FFmpeg it no longer can be fixed, FFmpeg will fvck up the already broken recording even further.  
 <sup>2</sup>: A minimal version of FFmpeg is bundled with the desktop edition of BililiveRecorder for the remux feature in toolbox.
 
-## Develop & Build
+## Versioning
 
-Visual Studio 2019 with .NET 5 is recommended, though any other IDE should work too.
+This project is following Semantic Versioning since version 2.0.0.
 
-Project | Target | Note
-:---:|:---:|:---:
-BililiveRecorder.WPF | .NET Framework 4.7.2 | Windows only GUI
-BililiveRecorder.Cli | .NET 5 | Cross-platform
-BililiveRecorder.ToolBox | .NET Standard 2.0 | library used by WPF & Cli
-BililiveRecorder.Core | .NET Standard 2.0 | Main recording logic
-BililiveRecorder.Flv | .NET Standard 2.0 | Data processing logic
+Please note this does not include the public .NET API of `BililiveRecorder.Flv`, or any project within this repository for that matter. They are considered as internal implementation thus could have breaking changes in any releases.
 
-## Versioning
+## Building from source
+
+Note: full git history is required for version generation to work.
+
+WPF version:
+
+```powershell
+cd BililiveRecorder.WPF
+msbuild -t:restore
+msbuild
+```
+
+Command line version:
+
+```sh
+# Build WebUI, optional
+git submodule update --init --recursive
+./webui/build.sh
+# For building on Windows:
+# ./webui/build.ps1
+
+dotnet build BililiveRecorder.Cli
+```
+
+## Project structure
+
+Project | Target |
+:--- |:--- |
+BililiveRecorder.Flv | .NET Standard 2.0 |
+BililiveRecorder.Core | .NET Standard 2.0 |
+BililiveRecorder.Toolbox | .NET Standard 2.0 |
+BililiveRecorder.WPF | .NET Framework 4.7.2 |
+BililiveRecorder.Web | .NET 6 |
+BililiveRecorder.Cli | .NET 6 |
 
-This project does not follow semantic versioning, no source code compatibility is guaranteed between any version.
+```mermaid
+graph BT
+    toolbox(BililiveRecorder.Toolbox) --> flv(BililiveRecorder.Flv)
+    core(BililiveRecorder.Core) --> flv
+    wpf(BililiveRecorder.WPF) --> core
+    wpf --> toolbox
+    cli(BililiveRecorder.Cli) --> toolbox
+    cli ---> core
+    web(BililiveRecorder.Web) --> core
+    cli --> web
+```
 
 ## Reference & Acknowledgements
 

diff --git a/README_CN.md b/README_CN.md
@@ -1,14 +1,26 @@
+<div style="text-align:center">
+<img width="20%" src=".github/assets/logo.svg">
+
 # B站录播姬
 
-[![Build and Test](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml/badge.svg)](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml)
-[![当前版本](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=当前版本)](#)
-[![开源协议](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg?label=开源协议)](#)
-[![QQ群 689636812](https://img.shields.io/badge/QQ%E7%BE%A4-689636812-success)](https://jq.qq.com/?_wv=1027&k=5zVwEyf)
+[![Build and Test](https://github.com/BililiveRecorder/BililiveRecorder/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/BililiveRecorder/BililiveRecorder/actions/workflows/build.yml)
+[![Version](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=Version)](#)
+[![License](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg)](#)
 [![Crowdin](https://badges.crowdin.net/bililiverecorder/localized.svg)](https://crowdin.com/project/bililiverecorder)
 
-## 安装 & 使用
+</div>
+
+## 安装
+
+在 [rec.danmuji.org](https://rec.danmuji.org) 提供了有自动更新功能的安装包。
+
+或者也可以在 [releases](https://github.com/BililiveRecorder/BililiveRecorder/releases) 页面下载 “绿色版” 压缩包，没有版本检查和更新功能。你可以 watch 本仓库的新版本发布（点击 “Watch” 、点击 “Custom”、勾选 “Releases”）。
 
-参见网站 [rec.danmuji.org](https://rec.danmuji.org)
+命令行版可执行文件可以在 [releases](https://github.com/BililiveRecorder/BililiveRecorder/releases) 页面下载，支持 Linux、 macOS 和 Windows 系统。
+
+可以在 [Docker Hub `bililive/recorder`](https://hub.docker.com/r/bililive/recorder) 或 [`ghcr.io/bililiverecorder/bililiverecorder`](https://github.com/bililiverecorder/BililiveRecorder/pkgs/container/bililiverecorder) 拉取 Docker 镜像。
+
+安装使用教程在 [rec.danmuji.org/user/install](https://rec.danmuji.org/user/install)。
 
 ## 功能
 
@@ -23,21 +35,58 @@
 <sup>1</sup>：仅限未经处理的直接从直播服务器下载的原始FLV文件。 如果录播是用 FFmpeg 录制的或处理过的就无法修复了，FFmpeg 会进一步损坏有问题的文件。  
 <sup>2</sup>：录播姬桌面版内含了一个 mini 版 FFmpeg 用于工具箱内的转封装功能。
 
-## 开发 & 编译
+## 版本号
 
-推荐使用选配了 .NET 5 开发的 Visual Studio 2019，不过其他 IDE 应该也可以。
+本项目从 2.0.0 开始使用 Semantic Versioning。
 
-项目 | 平台 | 备注
-:---:|:---:|:---:
-BililiveRecorder.WPF | .NET Framework 4.7.2 | Windows only GUI
-BililiveRecorder.Cli | .NET 5 | 跨平台命令行
-BililiveRecorder.ToolBox | .NET Standard 2.0 | WPF 和 Cli 使用的库
-BililiveRecorder.Core | .NET Standard 2.0 | 核心录制逻辑
-BililiveRecorder.Flv | .NET Standard 2.0 | 数据处理逻辑
+请注意各个项目（比如 `BililiveRecorder.Flv`）的 .NET API 就算是 public 的也属于内部实现，所以不保证任何版本之间源代码接口的兼容性。
 
-## 版本号
+## 编译
+
+注意：需要有完整的 git 历史才能生成版本号。
+
+WPF 版：
+
+```powershell
+cd BililiveRecorder.WPF
+msbuild -t:restore
+msbuild
+```
+
+命令行版：
+
+```sh
+# Build WebUI, optional
+git submodule update --init --recursive
+./webui/build.sh
+# For building on Windows:
+# ./webui/build.ps1
+
+dotnet build BililiveRecorder.Cli
+```
+
+## 项目结构
+
+Project | Target |
+:--- |:--- |
+BililiveRecorder.Flv | .NET Standard 2.0 |
+BililiveRecorder.Core | .NET Standard 2.0 |
+BililiveRecorder.Toolbox | .NET Standard 2.0 |
+BililiveRecorder.WPF | .NET Framework 4.7.2 |
+BililiveRecorder.Web | .NET 6 |
+BililiveRecorder.Cli | .NET 6 |
 
-本项目不使用 Semantic Versioning，不保证任何版本之间源代码接口的兼容性。
+```mermaid
+graph BT
+    toolbox(BililiveRecorder.Toolbox) --> flv(BililiveRecorder.Flv)
+    core(BililiveRecorder.Core) --> flv
+    wpf(BililiveRecorder.WPF) --> core
+    wpf --> toolbox
+    cli(BililiveRecorder.Cli) --> toolbox
+    cli ---> core
+    web(BililiveRecorder.Web) --> core
+    cli --> web
+```
 
 ## 参考资料 & 鸣谢