diff options
| -rw-r--r-- | .markdownlint.json | 5 | ||||
| -rw-r--r-- | README.CN.md | 13 | ||||
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | packages/docs/README.md | 7 |
4 files changed, 29 insertions, 9 deletions
diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..4c98f54 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,5 @@ +{ + "MD013": false, + "MD033": false, + "MD041": false +} diff --git a/README.CN.md b/README.CN.md index ff5cdd4..69773c6 100644 --- a/README.CN.md +++ b/README.CN.md @@ -1,5 +1,7 @@ # Drop*O*ut +[English](README.md) | 中文 + [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_small) [](https://github.com/pre-commit/pre-commit) [](https://results.pre-commit.ci/latest/github/HsiangNianian/DropOut/main) @@ -9,7 +11,7 @@ [](https://github.com/HydroRoll-Team/DropOut/actions/workflows/release.yml) [](https://github.com/HydroRoll-Team/DropOut/actions/workflows/test.yml) -DropOut 是一个现代的、可重现的、开发者级别的 Minecraft 启动器。 +DropOut 是一个现代的、可复现的、开发者级别的 Minecraft 启动器。 它不仅仅是为了启动 Minecraft 而设计的，而是将 Minecraft 环境作为确定性的、版本化的工作空间进行管理。 使用 Tauri v2 和 Rust 构建，DropOut 提供原生性能和最小资源使用，并配有现代响应式 Web UI（目前使用 Svelte 5，正在迁移到 React）。 @@ -98,6 +100,7 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 git clone https://github.com/HsiangNianian/DropOut.git cd DropOut ``` + 2. **安装前端依赖** ```bash @@ -105,12 +108,14 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 pnpm install cd .. ``` + 3. **运行开发模式** ```bash # 这将启动前端服务器和 Tauri 应用窗口 cargo tauri dev ``` + 4. **构建发布版本** ```bash @@ -123,6 +128,7 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 DropOut 以长期可维护性为目标构建。 欢迎贡献，尤其在这些领域： + - 实例系统设计 - 模组兼容性工具 - UI/UX 改进 @@ -131,12 +137,11 @@ DropOut 以长期可维护性为目标构建。 标准的 GitHub 工作流程适用： fork → 功能分支 → 拉取请求。 - ## 许可证 +根据 MIT 许可证分发。有关更多信息，请参见 `LICENSE`。 + [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=license) [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=security) [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_large) - -根据 MIT 许可证分发。有关更多信息，请参见 `LICENSE`。 @@ -1,5 +1,7 @@ # Drop*O*ut +English | [中文](README.CN.md) + [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_small) [](https://github.com/pre-commit/pre-commit) [](https://results.pre-commit.ci/latest/github/HsiangNianian/DropOut/main) @@ -56,7 +58,7 @@ This launcher is built for players who value control, transparency, and long-ter ## Roadmap -Check our full roadmap at: https://roadmap.sh/r/minecraft-launcher-dev +Check our full roadmap at: <https://roadmap.sh/r/minecraft-launcher-dev> - [X] **Account Persistence** — Save login state between sessions - [X] **Token Refresh** — Auto-refresh expired Microsoft tokens @@ -100,6 +102,7 @@ Download the latest release for your platform from the [Releases](https://github git clone https://github.com/HsiangNianian/DropOut.git cd DropOut ``` + 2. **Install Frontend Dependencies** ```bash @@ -107,12 +110,14 @@ Download the latest release for your platform from the [Releases](https://github pnpm install cd .. ``` + 3. **Run in Development Mode** ```bash # This will start the frontend server and the Tauri app window cargo tauri dev ``` + 4. **Build Release Version** ```bash @@ -125,6 +130,7 @@ Download the latest release for your platform from the [Releases](https://github DropOut is built with long-term maintainability in mind. Contributions are welcome, especially in these areas: + - Instance system design - Mod compatibility tooling - UI/UX improvements @@ -133,12 +139,11 @@ Contributions are welcome, especially in these areas: Standard GitHub workflow applies: fork → feature branch → pull request. - ## License +Distributed under the MIT License. See `LICENSE` for more information. + [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=license) [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=security) [](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_large) - -Distributed under the MIT License. See `LICENSE` for more information. diff --git a/packages/docs/README.md b/packages/docs/README.md index 63b9290..f4e7563 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -5,6 +5,7 @@ This is the official documentation site for DropOut Minecraft Launcher, built wi ## Overview The documentation covers: + - **Getting Started**: Installation and first-time setup - **Features**: Detailed guides for all launcher features - **Architecture**: Technical design and implementation details @@ -14,6 +15,7 @@ The documentation covers: ### Multi-language Support The documentation is available in: + - **English** (default) - `content/docs/en/` - **简体中文** (Simplified Chinese) - `content/docs/zh/` @@ -68,7 +70,7 @@ pnpm format ## Project Structure -``` +```bash packages/docs/ ├── content/ │ └── docs/ # Documentation content (MDX) @@ -97,6 +99,7 @@ packages/docs/ ### Structure Documentation is organized by locale: + - English: `content/docs/en/` - Chinese: `content/docs/zh/` @@ -105,6 +108,7 @@ Each locale has the same structure with translated content. ### Configuration i18n is configured in: + - `source.config.ts`: Enables i18n support - `app/lib/source.ts`: Defines available languages and default @@ -160,6 +164,7 @@ Fumadocs provides several components: ### Translation Guidelines When translating content: + - Keep all code blocks in English - Translate frontmatter (title, description) - Keep technical terms (Tauri, Rust, Svelte, etc.) in English |