From e388656d68d3fde93ffecd708f3891da654797bf Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:17:28 +0800 Subject: [PATCH 01/25] Create README_en.md --- README_en.md | 213 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 README_en.md diff --git a/README_en.md b/README_en.md new file mode 100644 index 000000000..b4255ad2c --- /dev/null +++ b/README_en.md @@ -0,0 +1,213 @@ +Language: English|Simplified Chinese +
+ +
+ +# Meowbili - Bilibili client on Apple Watch + +![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg) +![GitHub Repo stars](https://img.shields.io/github/stars/Darock-Studio/Darock-Bili?style=flat) +![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Darock-Studio/Darock-Bili) +![GitHub repo size](https://img.shields.io/github/repo-size/Darock-Studio/Darock-Bili) +![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Darock-Studio/Darock-Bili) +![Uptime Robot status](https://img.shields.io/uptimerobot/status/m794152937-528042e5aee699af3224e7a6?label=Darock%20Main%20API%20Status) +![GitHub tag](https://img.shields.io/github/v/tag/Darock-Studio/Darock-Bili?label=Latest%20Tag) +![GitHub Release Date](https://img.shields.io/github/release-date-pre/Darock-Studio/Darock-Bili?label=Latest%20Release%20Date) +![GitHub last commit (branch)](https://img.shields.io/github/last-commit/Darock-Studio/Darock-Bili/main?label=Main%20Branch%20Last%20Commit) +![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Darock-Studio/Darock-Bili/ios.yml) + ++ +
+ +## ✨Features +- Customized Suggestion +- Account Login +- Video Download +- View Video Details(Play counts、introduction...) +- View Video Comments +- Send Comments +- View Suggested Video +- Video Actions(Like、Throw Coins、Add to favorites...) +- User Detail Page(Fans、Follows count,User bio...) +- User Videos and Articles +- User Actions(Follow、D.M.) +- Search(Videos、Users) +- Follow List +- Favorites(Folder) +- Watch Later(View、Add) +- View Moments + +## ⬇️Install +### TestFlight +[Here](https://testflight.apple.com/join/TbuBT6ig) + +## 🙌Contribute +Welcome to open issues and pull requests to help us get better. + +View contribute/develop document at [/doc/dev](/doc/dev) + +From bfd747ee977b29b0db1b424d73f9acedb2a88890 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:27:49 +0800 Subject: [PATCH 03/25] Add lang switcher --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 95cfacd81..07dbd6c47 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +语言:简体中文|English
From 4281eab3846b300eeb7700d7b76018e087e40367 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:29:14 +0800 Subject: [PATCH 04/25] Add lang switcher --- README_en.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README_en.md b/README_en.md index f1f67dbad..5dda8caa1 100644 --- a/README_en.md +++ b/README_en.md @@ -1,3 +1,4 @@ +Language: 简体中文|English
From edc4eefdc363b124f163137278e19fc502cfceb3 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:32:32 +0800 Subject: [PATCH 05/25] Update README_en.md --- README_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index 5dda8caa1..5aaa423c7 100644 --- a/README_en.md +++ b/README_en.md @@ -159,7 +159,7 @@ Open an Pull Request->Wait for review->Repair problem (if have)->Wait for compil Everyone(including administrators)cannot skip any steps. -## 📝版本号 +## 📝Version Number Meowbili's Version number is **different** on GitHub and TestFlight(Same on about page). Because if add Version number on Testflight, app need to review by Apple. But if only add build number can prevent this. So, we only add build number on Testflight. However, on Github we use easy to understand version number. We recommanded to use version number on Github to identity Meowbili. From 8079c1c51a2517d221c62ace1f8aeac39a371fbc Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:33:21 +0800 Subject: [PATCH 06/25] Update README_en.md --- README_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index 5aaa423c7..6807e440e 100644 --- a/README_en.md +++ b/README_en.md @@ -155,7 +155,7 @@ View contribute/develop document at [/doc/dev](/doc/dev) ### Contribute Steps -Open an Pull Request->Wait for review->Repair problem (if have)->Wait for compile ckeck->merge to main(or Close Pull Request) +Open an Pull Request->Wait for review->Repair problem (if have)->Wait for compile check->merge to main(or Close Pull Request) Everyone(including administrators)cannot skip any steps. From ca1b1b5dad8979da463de18c2d867a4130c2df49 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:35:28 +0800 Subject: [PATCH 07/25] Update README_en.md --- README_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index 6807e440e..16fc88601 100644 --- a/README_en.md +++ b/README_en.md @@ -164,7 +164,7 @@ Meowbili's Version number is **different** on GitHub and TestFlight(Same on abou So, we only add build number on Testflight. However, on Github we use easy to understand version number. We recommanded to use version number on Github to identity Meowbili. -## 💬User Commits (in Chinese) +## 💬User Comments (in Chinese) ~~When people used this, they all say good~~ > [!TIP] From b93ed0100d1d93a54a90a1be0712a08030541105 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:55:48 +0800 Subject: [PATCH 08/25] Translated user comments --- README_en.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README_en.md b/README_en.md index 16fc88601..729873cf7 100644 --- a/README_en.md +++ b/README_en.md @@ -164,34 +164,34 @@ Meowbili's Version number is **different** on GitHub and TestFlight(Same on abou So, we only add build number on Testflight. However, on Github we use easy to understand version number. We recommanded to use version number on Github to identity Meowbili. -## 💬User Comments (in Chinese) +## 💬User Comments ~~When people used this, they all say good~~ > [!TIP] -> 当我发现我可以在Apple Watch上直接浏览哔哩哔哩的内容时,我的兴奋可想而知。这要归功于“喵哩喵哩”这款小巧而强大的应用。作为一个整日不离手的智能手表,Apple Watch对于我来说早已不止是时间显示和运动追踪,它逐渐演变成了我的日常生活中的小秘书。但现在,随着“喵哩喵哩”的出现,它的功能越发丰富,我的娱乐生活也因此而提升。 +> When I found that I could browse Bilibili directly on Apple Watch, my excitement was imaginable. This is thanks to the small and powerful application of Meowbili.As a smart watch that never leaves my hands all day long, Apple Watch is not only a time display and motion tracking for me, but also has gradually evolved into a little secretary in my daily life. But now, with the emergence of Meowbili, its functions have become richer and richer, and my entertainment life has also improved. > -> 首先要赞赏的是“喵哩喵哩”的设计。这款应用针对Apple Watch的小屏幕做了极佳的优化。它的界面干净且直观,方便用户在屏幕尺寸有限的情况下,快速地浏览和搜索内容。字体大小和按钮布局考虑到了触控的便利性,不会让人觉得拥挤或难以操作。 +> The first thing to appreciate is the design of Meowbili. This app is excellently optimized for the small screen of Apple Watch. Its interface is clean and intuitive, which is convenient for users to quickly browse and search for content with limited screen size. The font size and button layout take into account the convenience of touch and will not make people feel crowded or difficult to operate. > -> 其次,功能上的实用性也是我极大的喜爱之处。虽然Apple Watch的屏幕并不适合长时间观看视频,但“喵哩喵哩”让我能在空闲之余迅速地查看更新,了解最新动态,甚至在不便拿出手机的情况下观看一些短视频或者收听up主的声音。这样的体验让我感到十分便捷。 +> Secondly, the practicality of functions is also my favorite. Although the screen of Apple Watch is not suitable for watching videos for a long time, Meowbili allows me to quickly check the updates in my spare time, keep abreast of the latest developments, and even watch some short videos or listen to the voice of the uploader when it is inconvenient to take out the mobile phone. This kind of experience makes me feel very convenient. > -> 总的来说,“喵哩喵哩”不仅为我日常的Apple Watch使用增添了乐趣,同时也满足了我作为一个视频内容爱好者的需求。它是那些喜欢在任何时间地点都保持在线的用户的必备应用。 +> Generally speaking, Meowbili not only adds fun to my daily use of Apple Watch, but also meets my needs as a video content enthusiast. It is a must-have application for users who like to stay online at any time and anywhere. > -> ————陵长镜 +> ————Ling Changjing > [!TIP] -> 如果我高一, +> If I am first year in high school, > -> 我会写七言情诗,引经据典行行不提喜欢; +> I will write seven romance poems, citing the scriptures and not mentioning what I like; > -> 如果我高二, +> If I am second year in high school, > -> 我会写千字散文,辞藻华丽句句点名爱意; +> I can write thousands of words of prose, and the words are gorgeous and full of love; > -> 如果我高三, +> If I am second year in high school, > -> 我会写一纸情书,哲思神秘再融进荣格和弗洛伊; +> I will write a love letter, and the mystery of philosophy will be integrated into Jung and Freud; > -> 可惜我现在幼儿园,我只会说,喵哩喵哩我好喜欢你,喵哩喵哩😭😭你带我走吧🚗……喵哩喵哩🏃…喵哩喵哩🏃…喵哩喵哩🧎没有你我怎么活啊😭 +> It's a pity that I'm in kindergarten now, and I can only say, Meowbili 😭😭 take me away 🚗... Meowbili 🏃... Meowbili 🧎 how can I live without you 😭 > > ————Miku @@ -203,11 +203,11 @@ So, we only add build number on Testflight. However, on Github we use easy to un > ————ThreeManager785 > [!TIP] -> 你说的对,但是喵哩喵哩是由 Darock 研发的一款开源世界B站第三方 Apple Watch 客户端。游戏发生在一个名为“学校”的真实世界,在这里,被老师选中的人会被没收手机,引导 Apple Watch 之力。你将扮演一位名为“学生”的神秘角色,在教室中浏览性格各异能力独特的视频们,和他们一起击败强敌,找回失散的MEMZ。 +> You're right, but Meowbili is an open source world Bilivili third-party Apple Watch client developed by Darock. The game takes place in a real world called "School", where the person selected by the teacher will confiscate the mobile phone and guide the power of Apple Watch. You will play a mysterious role named "student", browse videos with different personalities and abilities in the classroom, defeat the strong enemy with them, and find the lost MEMZ. > [!TIP] -> 巴山楚水凄凉地,平面直角坐标系 +> Bashan Chushui is desolate, and the plane is rectangular coordinate system. > -> responsibility,aw也能看视频 +> responsibility,aw can also watch videos > -> 高猛酸钾制氧气,喵哩喵哩真nb +> High potassium fermentic acid to produce oxygen, Meowbili is so NB From b5567ab7ebe2b04f6699e39aa3222df8b30a8c00 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:59:31 +0800 Subject: [PATCH 09/25] Update README_en.md --- README_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index 729873cf7..4fc796d53 100644 --- a/README_en.md +++ b/README_en.md @@ -187,7 +187,7 @@ So, we only add build number on Testflight. However, on Github we use easy to un > > I can write thousands of words of prose, and the words are gorgeous and full of love; > -> If I am second year in high school, +> If I am third year in high school, > > I will write a love letter, and the mystery of philosophy will be integrated into Jung and Freud; > From 893bec748649333c97fde233cda525badface847 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 03:32:10 +0800 Subject: [PATCH 10/25] fix errors --- README_en.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README_en.md b/README_en.md index 4fc796d53..7edafba21 100644 --- a/README_en.md +++ b/README_en.md @@ -31,7 +31,7 @@ Language: 简体中文|English - Video Actions(Like、Throw Coins、Add to favorites...) - User Detail Page(Fans、Follows count,User bio...) - User Videos and Articles -- User Actions(Follow、D.M.) +- User Actions(Follow、Direct Message) - Search(Videos、Users) - Follow List - Favorites(Folder) @@ -203,11 +203,5 @@ So, we only add build number on Testflight. However, on Github we use easy to un > ————ThreeManager785 > [!TIP] -> You're right, but Meowbili is an open source world Bilivili third-party Apple Watch client developed by Darock. The game takes place in a real world called "School", where the person selected by the teacher will confiscate the mobile phone and guide the power of Apple Watch. You will play a mysterious role named "student", browse videos with different personalities and abilities in the classroom, defeat the strong enemy with them, and find the lost MEMZ. +> You're right, but Meowbili is an open source world Bilibili third-party Apple Watch client developed by Darock. The game takes place in a real world called "School", where the person selected by the teacher will confiscate the mobile phone and guide the power of Apple Watch. You will play a mysterious role named "student", browse videos with different personalities and abilities in the classroom, defeat the strong enemy with them, and find the lost MEMZ. -> [!TIP] -> Bashan Chushui is desolate, and the plane is rectangular coordinate system. -> -> responsibility,aw can also watch videos -> -> High potassium fermentic acid to produce oxygen, Meowbili is so NB From 1413f76710e397b6484f18d8d85502aa8cad9955 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:13:48 +0800 Subject: [PATCH 11/25] Rename doc/dev/README.md to doc/dev/zh-cn/README.md --- doc/dev/{ => zh-cn}/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/dev/{ => zh-cn}/README.md (100%) diff --git a/doc/dev/README.md b/doc/dev/zh-cn/README.md similarity index 100% rename from doc/dev/README.md rename to doc/dev/zh-cn/README.md From 00baef8dbd9dd94c66323b2fd03db526c6352aa5 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:14:27 +0800 Subject: [PATCH 12/25] Rename doc/dev/build.md to doc/dev/zh-cn/build.md --- doc/dev/{ => zh-cn}/build.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/dev/{ => zh-cn}/build.md (100%) diff --git a/doc/dev/build.md b/doc/dev/zh-cn/build.md similarity index 100% rename from doc/dev/build.md rename to doc/dev/zh-cn/build.md From 0f61ae4792bee411d9efbf80aeccf880f23edbe9 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:14:54 +0800 Subject: [PATCH 13/25] Rename doc/dev/ci.md to doc/dev/zh-cn/ci.md --- doc/dev/{ => zh-cn}/ci.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/dev/{ => zh-cn}/ci.md (100%) diff --git a/doc/dev/ci.md b/doc/dev/zh-cn/ci.md similarity index 100% rename from doc/dev/ci.md rename to doc/dev/zh-cn/ci.md From dc0acabda3643df9727f1951d8536d1b6b6a3d60 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:15:14 +0800 Subject: [PATCH 14/25] Rename doc/dev/debug.md to doc/dev/zh-cn/debug.md --- doc/dev/{ => zh-cn}/debug.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/dev/{ => zh-cn}/debug.md (100%) diff --git a/doc/dev/debug.md b/doc/dev/zh-cn/debug.md similarity index 100% rename from doc/dev/debug.md rename to doc/dev/zh-cn/debug.md From b2b2867ac81b587443b2dfba461b5feee547c685 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:15:37 +0800 Subject: [PATCH 15/25] Rename doc/dev/first-pr.md to doc/dev/zh-cn/first-pr.md --- doc/dev/{ => zh-cn}/first-pr.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/dev/{ => zh-cn}/first-pr.md (100%) diff --git a/doc/dev/first-pr.md b/doc/dev/zh-cn/first-pr.md similarity index 100% rename from doc/dev/first-pr.md rename to doc/dev/zh-cn/first-pr.md From 2ea1361746547e787442da28fbecf2da49630d08 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:17:16 +0800 Subject: [PATCH 16/25] Create README.md --- doc/dev/README.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 doc/dev/README.md diff --git a/doc/dev/README.md b/doc/dev/README.md new file mode 100644 index 000000000..b52c67797 --- /dev/null +++ b/doc/dev/README.md @@ -0,0 +1,2 @@ +# 请选择一种语言以查看开发文档 +## Please select a language to view develop docs From ac0aa1041e402016ad6f05e3b7848daf62c36c40 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:19:38 +0800 Subject: [PATCH 17/25] Create README.md in en-us --- doc/dev/en-us/README.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 doc/dev/en-us/README.md diff --git a/doc/dev/en-us/README.md b/doc/dev/en-us/README.md new file mode 100644 index 000000000..101bc99b5 --- /dev/null +++ b/doc/dev/en-us/README.md @@ -0,0 +1,2 @@ +# Develop Docs +This place is the develop docs of Meowbili, information and documents of code and developing is here. From ba40eb69624cfea580e20b1b601833289f02e1b8 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:28:09 +0800 Subject: [PATCH 18/25] Partial translate for build.md --- doc/dev/en-us/Build.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 doc/dev/en-us/Build.md diff --git a/doc/dev/en-us/Build.md b/doc/dev/en-us/Build.md new file mode 100644 index 000000000..cd5c90d2d --- /dev/null +++ b/doc/dev/en-us/Build.md @@ -0,0 +1,15 @@ +# Compile this Project +The first step of developing is compiling! 无论您是想要为喵哩喵哩贡献,或是想自己修改部分代码,您都需要在此之前成功编译喵哩喵哩。本文档提供了一些编译帮助。 +## Requirement +### Device +You need a Mac runs the latest version of macOS in order to compile Meowbili. +### Environment +您的 Mac 需要安装最新版本的 Xcode,并在 Xcode 中安装最新版 **watchOS** 和 iOS 的 SDK。 +## Compile Steps +1. Clone this repository locally. +2. Open `DarockBili.xcodeproj` +3. 等待依赖包处理(需要一个良好的网络环境) +4. 在**项目设置**中选择您自己的开发团队 +5. Start compiling! +## Troubleshooting +上面的步骤应该能直接完成项目的编译,如果您在编译中遇到问题,您可以**搜索错误信息**以尝试找到解决方案。 From af03632056affafda8b10e60ed14a5a22033ea5b Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 04:44:50 +0800 Subject: [PATCH 19/25] partial translate of first-pr.md --- doc/dev/en-us/first-pr.md | 45 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/dev/en-us/first-pr.md diff --git a/doc/dev/en-us/first-pr.md b/doc/dev/en-us/first-pr.md new file mode 100644 index 000000000..402aca7c3 --- /dev/null +++ b/doc/dev/en-us/first-pr.md @@ -0,0 +1,45 @@ +# Open Your First Pull Request +Decide to contribute to Meowbili? Welcom! Maybe this is your first time to contribute to open source project, or you are an experienced open source contributor. Whatever, we're glad to see your contributes. + +This docs can provide help on contribute +## What can I do? +If you don't know what can you help, you can start from checking issues. Resolve pronlems mentioned in issue, and: +- Check commits under issue and Pull Request list. Ensure none is resolving this issue. + + 如果您看到一个 Pull Request 很久没有更新活动,您也可以开始尝试为此工作。 +- Commits under issue to explain you're working on this issue. +## Get Help +处理问题时,您将可能遇到很多问题,例如,您可能会有这些问题: +- 有关于 X 的文档吗? +- 我在尝试 Build 时遇到了 X 错误,如何解决它? +- 我不确定如何实现 X ,有什么建议以便我走出第一步吗? +- 我应该为新的 X 创建一个单独的文件吗? +- 我如何测试是否真的修复了此错误? +- 如何使用 git 做 X ? +其中的一些问题可以在我们的文档中找到答案,也许您有在文档中找不到的问题,没关系,还有一些方法可以取得帮助: +- 开启一个 Issue 或在您工作的 Pull Request 下提问。 +## Open Pull Request +Done all works? You can open a Pull Request now. +### Create Pull Request +Select Compare & Pull Request on your fork to create a Pull Request。 + +If you not done yet,you can open a Draft Pull Request. + +## Request to Merge +### Complete Check List +We require completing all check list before merging. User with access can run check. Details at [CI Docs](/doc/dev/en-us/ci.md) + +### Request Review +在您准备好接受审查后,您可以在GitHub右侧要求 @WindowsMEMZ 审查您的代码 + +### Merging +您可以要求拥有权限的用户进行合并。在完成更改后,请@一位拥有权限的用户并请求合并,他们将审核您的提交并进行合并。 + +## I Cannot Complete My Contribute! +No problem! 这并不是件丢人的事。您只有有限的时间来为项目做贡献。如果可以,请在 Issue 或 Pull Request 下回复您将无法继续完成贡献。无需解释您为什么这样做,我们理解并尊重您,您应当为自己花更多时间。 + +## My Pull Request was merged! + +Thanks for your contribute to Meowbili project.欢迎您继续多多帮助喵哩喵哩项目,无论是回答问题还是提交 Pull Request。 + +在您做出了多个实质性的贡献后,您可以申请提交权限,这将使您能够更方便地贡献喵哩喵哩项目。 From 4b838fc5a9488006f911275f481267d234b68413 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 12:06:49 +0800 Subject: [PATCH 20/25] complete translated build.md --- doc/dev/en-us/Build.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/dev/en-us/Build.md b/doc/dev/en-us/Build.md index cd5c90d2d..c379fdf7e 100644 --- a/doc/dev/en-us/Build.md +++ b/doc/dev/en-us/Build.md @@ -1,15 +1,15 @@ # Compile this Project -The first step of developing is compiling! 无论您是想要为喵哩喵哩贡献,或是想自己修改部分代码,您都需要在此之前成功编译喵哩喵哩。本文档提供了一些编译帮助。 +The first step of developing is compiling! Wahtever you want to contribute to Meowbili, or you want to develop your own edition. This docs provided helps on compiling Meowbili. ## Requirement ### Device You need a Mac runs the latest version of macOS in order to compile Meowbili. ### Environment -您的 Mac 需要安装最新版本的 Xcode,并在 Xcode 中安装最新版 **watchOS** 和 iOS 的 SDK。 +You need to install the latest version of XCode, and install the latest **WatchOS** and iOS sdk. ## Compile Steps 1. Clone this repository locally. 2. Open `DarockBili.xcodeproj` -3. 等待依赖包处理(需要一个良好的网络环境) -4. 在**项目设置**中选择您自己的开发团队 +3. Wait for depends processing(Need a good network envirnment) +4. Select your development team at **Project Settings** 5. Start compiling! ## Troubleshooting -上面的步骤应该能直接完成项目的编译,如果您在编译中遇到问题,您可以**搜索错误信息**以尝试找到解决方案。 +Steps above can successfully compile Meowbili. If you have troubles in compiling Meowbili, you can **Search Error Info** to find solution. From 432fd3afcd2310459807d12485881a701bbc9233 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 12:30:08 +0800 Subject: [PATCH 21/25] complete translated first-pr.md --- doc/dev/en-us/first-pr.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/dev/en-us/first-pr.md b/doc/dev/en-us/first-pr.md index 402aca7c3..afab6d02d 100644 --- a/doc/dev/en-us/first-pr.md +++ b/doc/dev/en-us/first-pr.md @@ -6,18 +6,18 @@ This docs can provide help on contribute If you don't know what can you help, you can start from checking issues. Resolve pronlems mentioned in issue, and: - Check commits under issue and Pull Request list. Ensure none is resolving this issue. - 如果您看到一个 Pull Request 很久没有更新活动,您也可以开始尝试为此工作。 + If you see a Pull Request with no activities for a long time, you also can try to working on this. - Commits under issue to explain you're working on this issue. ## Get Help -处理问题时,您将可能遇到很多问题,例如,您可能会有这些问题: -- 有关于 X 的文档吗? -- 我在尝试 Build 时遇到了 X 错误,如何解决它? -- 我不确定如何实现 X ,有什么建议以便我走出第一步吗? -- 我应该为新的 X 创建一个单独的文件吗? -- 我如何测试是否真的修复了此错误? -- 如何使用 git 做 X ? -其中的一些问题可以在我们的文档中找到答案,也许您有在文档中找不到的问题,没关系,还有一些方法可以取得帮助: -- 开启一个 Issue 或在您工作的 Pull Request 下提问。 +When working on issues, you may get into troubles. For example, you may ran into following troubles: +- Have documents for it? +- An error occurred while building. How to reslove it? +- I'm not sure about how to implement it. Have it something suggestions to make my first step? +- Should I create a standalone file for it? +- How to verify I really fixed this issue? +- How to do it with Git? + Some questions can found the solution in our documents. Maybe you have some problems that cannot be found in our documents. It doesn't matter! There are some other ways to get help on questions: +- Open an Issue or ask on your Pull Request. ## Open Pull Request Done all works? You can open a Pull Request now. ### Create Pull Request @@ -30,16 +30,16 @@ If you not done yet,you can open a Draft Pull Request. We require completing all check list before merging. User with access can run check. Details at [CI Docs](/doc/dev/en-us/ci.md) ### Request Review -在您准备好接受审查后,您可以在GitHub右侧要求 @WindowsMEMZ 审查您的代码 +After you ready for review, you can request @WindowsMEMZ for review on the right side of Github. ### Merging -您可以要求拥有权限的用户进行合并。在完成更改后,请@一位拥有权限的用户并请求合并,他们将审核您的提交并进行合并。 +You can request everyone who have write access to merge. After completing changes, please @ a user who have access to request merge. They'll review your commit and merge. ## I Cannot Complete My Contribute! -No problem! 这并不是件丢人的事。您只有有限的时间来为项目做贡献。如果可以,请在 Issue 或 Pull Request 下回复您将无法继续完成贡献。无需解释您为什么这样做,我们理解并尊重您,您应当为自己花更多时间。 +No problem! This is not a shame! You only have limited time to contribute. If you can, please commit to Issue or Pull Request to explain you cannot continue contributing. No reason required. We understand and respect you. You should spend more time on yourselves. ## My Pull Request was merged! -Thanks for your contribute to Meowbili project.欢迎您继续多多帮助喵哩喵哩项目,无论是回答问题还是提交 Pull Request。 +Thanks for your contribute to Meowbili project. Welcome to contribute more to Meowbili. Whatever answering questions or opening Pull Request. -在您做出了多个实质性的贡献后,您可以申请提交权限,这将使您能够更方便地贡献喵哩喵哩项目。 +After you contribute more time, you can request for a write access. This helps you easier to contribute to Meowbili. From d29be3b4bd377392f58907b7cbfff767e37cb422 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 12:52:16 +0800 Subject: [PATCH 22/25] Translated ci.md --- doc/dev/en-us/ci.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/dev/en-us/ci.md diff --git a/doc/dev/en-us/ci.md b/doc/dev/en-us/ci.md new file mode 100644 index 000000000..96418d554 --- /dev/null +++ b/doc/dev/en-us/ci.md @@ -0,0 +1,24 @@ +# CI Docs +What is CI? It means *Continuous integration*. Speak in easily, this is a machine that can compiling and more. + +CI Darock using is from Github Actions and XCode Cloud. Xcode Cloud's call is automatic, and you cannot call it manually. So this docs is mainly introduce Github Actions. +## Call +You can commit under Pull Request to call CI. +### compileable Check + All Pull Requests need to pass compileable check before it merge to **main** branch. This operation is complete by CI. + +Send `!Run check` to perform compileable check workflow. +### Export IPA + You can export an signed IPA through CI in roder for test. However, you cannot distribute it. + +Send `!Export IPA` to perform Export IPA workflow. +### Upload to TestFlight +You can compile and upload a branch to Testflight through CI in order for test. However, you cannot use it for distribution. + +**This workflow will cause whole project build number +1** + +Send `!Deploy TF` to perform upload workflow. +## View Status +As soon as workflow started, you can find status under pull request or Actions page. + +In Actions' **Summary** page, if this operation include file (e.g. `Export IPA`), you can get attachment below. From 66fad325147d298d56700bbaf33d493641ad8799 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 13:10:05 +0800 Subject: [PATCH 23/25] Translated debug.md --- doc/dev/en-us/debug.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 doc/dev/en-us/debug.md diff --git a/doc/dev/en-us/debug.md b/doc/dev/en-us/debug.md new file mode 100644 index 000000000..2acd9852f --- /dev/null +++ b/doc/dev/en-us/debug.md @@ -0,0 +1,15 @@ +# Debug +After successfully compiled Meowbili, you can start debugging Meowbili. This docs provided help on debugging. +## Select Target Platform +You can use SwiftUI Preview, emulator or real devices to debug Meowbili. As for different debug purpose, there are some different suggest platform. +- Debugging static UI, use SwiftUI Preview +- Debugging network data, use emulator +- Debugging video play, picture select and similar functions, use real device + +Running player on emulator may occurr stuck. You must use real device to debug. +## Debug Output +At most of time, we need to view contents in varible. We can use debug output at that time. + +You can use `debugPrint(_: Any...)` method to print varible content. However, please delete them before commit. + +You can also use breakpoint debugging. Breakpoint **in varible score**. And set breakpoint to run `lldb` command (e.g. use `po [varible]` to print varible). You're not suposed to delete breakpoints before commit. .gitignore file will skip breakpoint information. From 918abc8407d13aae2028d661e6303238040f526d Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 13:31:25 +0800 Subject: [PATCH 24/25] fix errors in build.md --- doc/dev/en-us/Build.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/dev/en-us/Build.md b/doc/dev/en-us/Build.md index c379fdf7e..48417b012 100644 --- a/doc/dev/en-us/Build.md +++ b/doc/dev/en-us/Build.md @@ -1,14 +1,14 @@ # Compile this Project -The first step of developing is compiling! Wahtever you want to contribute to Meowbili, or you want to develop your own edition. This docs provided helps on compiling Meowbili. +The first step of developing is compiling! Whatever you want to contribute to Meowbili, or you want to develop your own edition. This docs provided helps on compiling Meowbili. ## Requirement ### Device You need a Mac runs the latest version of macOS in order to compile Meowbili. ### Environment -You need to install the latest version of XCode, and install the latest **WatchOS** and iOS sdk. +You need to install the latest version of Xcode, and install the latest **WatchOS** and iOS sdk. ## Compile Steps 1. Clone this repository locally. 2. Open `DarockBili.xcodeproj` -3. Wait for depends processing(Need a good network envirnment) +3. Wait for depends processing(Need a good network environment) 4. Select your development team at **Project Settings** 5. Start compiling! ## Troubleshooting From 03ccefa09841287a8ea5c046bc7a4e28d7ac3707 Mon Sep 17 00:00:00 2001 From: Weidong Cheng <69106177+Linecom-lik@users.noreply.github.com> Date: Sun, 11 Feb 2024 13:32:19 +0800 Subject: [PATCH 25/25] fix error ci.md --- doc/dev/en-us/ci.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/dev/en-us/ci.md b/doc/dev/en-us/ci.md index 96418d554..023188c15 100644 --- a/doc/dev/en-us/ci.md +++ b/doc/dev/en-us/ci.md @@ -1,7 +1,7 @@ # CI Docs What is CI? It means *Continuous integration*. Speak in easily, this is a machine that can compiling and more. -CI Darock using is from Github Actions and XCode Cloud. Xcode Cloud's call is automatic, and you cannot call it manually. So this docs is mainly introduce Github Actions. +CI Darock using is from Github Actions and Xcode Cloud. Xcode Cloud's call is automatic, and you cannot call it manually. So this docs is mainly introduce Github Actions. ## Call You can commit under Pull Request to call CI. ### compileable Check