Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

翻译开发文档 #196

Merged
merged 26 commits into from
Feb 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
e388656
Create README_en.md
Linecom233 Feb 10, 2024
ddd210d
Remove language switcher
Linecom233 Feb 10, 2024
bfd747e
Add lang switcher
Linecom233 Feb 10, 2024
4281eab
Add lang switcher
Linecom233 Feb 10, 2024
edc4eef
Update README_en.md
Linecom233 Feb 10, 2024
8079c1c
Update README_en.md
Linecom233 Feb 10, 2024
ca1b1b5
Update README_en.md
Linecom233 Feb 10, 2024
b93ed01
Translated user comments
Linecom233 Feb 10, 2024
b5567ab
Update README_en.md
Linecom233 Feb 10, 2024
893bec7
fix errors
Linecom233 Feb 10, 2024
c02bf0a
Merge branch 'Darock-Studio:main' into main
Linecom233 Feb 10, 2024
1413f76
Rename doc/dev/README.md to doc/dev/zh-cn/README.md
Linecom233 Feb 10, 2024
00baef8
Rename doc/dev/build.md to doc/dev/zh-cn/build.md
Linecom233 Feb 10, 2024
0f61ae4
Rename doc/dev/ci.md to doc/dev/zh-cn/ci.md
Linecom233 Feb 10, 2024
dc0acab
Rename doc/dev/debug.md to doc/dev/zh-cn/debug.md
Linecom233 Feb 10, 2024
b2b2867
Rename doc/dev/first-pr.md to doc/dev/zh-cn/first-pr.md
Linecom233 Feb 10, 2024
2ea1361
Create README.md
Linecom233 Feb 10, 2024
ac0aa10
Create README.md in en-us
Linecom233 Feb 10, 2024
ba40eb6
Partial translate for build.md
Linecom233 Feb 10, 2024
af03632
partial translate of first-pr.md
Linecom233 Feb 10, 2024
4b838fc
complete translated build.md
Linecom233 Feb 11, 2024
432fd3a
complete translated first-pr.md
Linecom233 Feb 11, 2024
d29be3b
Translated ci.md
Linecom233 Feb 11, 2024
66fad32
Translated debug.md
Linecom233 Feb 11, 2024
918abc8
fix errors in build.md
Linecom233 Feb 11, 2024
03ccefa
fix error ci.md
Linecom233 Feb 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/dev/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# 开发文档
此处为喵哩喵哩开发文档,与代码、开发相关的说明和文档将在此处。
# 请选择一种语言以查看开发文档
## Please select a language to view develop docs
15 changes: 15 additions & 0 deletions doc/dev/en-us/Build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Compile this Project
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.
## Compile Steps
1. Clone this repository locally.
2. Open `DarockBili.xcodeproj`
3. Wait for depends processing(Need a good network environment)
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.
2 changes: 2 additions & 0 deletions doc/dev/en-us/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Develop Docs
This place is the develop docs of Meowbili, information and documents of code and developing is here.
24 changes: 24 additions & 0 deletions doc/dev/en-us/ci.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions doc/dev/en-us/debug.md
Original file line number Diff line number Diff line change
@@ -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.
45 changes: 45 additions & 0 deletions doc/dev/en-us/first-pr.md
Original file line number Diff line number Diff line change
@@ -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.

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
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
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
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! 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. 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.
2 changes: 2 additions & 0 deletions doc/dev/zh-cn/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# 开发文档
此处为喵哩喵哩开发文档,与代码、开发相关的说明和文档将在此处。
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.