diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be82c4d --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +CaelLab BY-SA Code License + +Copyright (c) 2026 Yunyun(云云) By 虚舟实验室(CaelLab) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this work (the "Work"), to use, copy, modify, merge, publish, distribute, +sublicense, and/or sell copies of the Work, for personal, commercial, or +non-commercial purposes, subject to the following conditions: + +1. Source Availability: If you distribute the Work, or any derivative work + based on the Work, you must make the complete corresponding source code + available under the terms of this same license. + +2. License Preservation: The above copyright notice and this permission notice + shall be included in all copies or substantial portions of the Work. + +3. ShareAlike: Any distributed derivative work must be licensed under the + CaelLab BY-SA Code License. + +THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. \ No newline at end of file diff --git a/README.md b/README.md index ae7eb91..486aa15 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,74 @@ -# GoodPlanCraftLaunCher -GPCL是简洁高效的 Minecraft 启动器。 +# GoodPlanCraftLaunCher (GPCL) + +简洁高效的 Minecraft 启动器。 + +## 制作方法 + +使用[Electron](https://www.electronjs.org/zh/docs/latest/)进行制作。 + +## 安装 + +### 从源码构建 + +```bash +git clone https://github.com/yunyun-3782/GoodPlanCraftLaunCher.git +``` + +### 预编译版本 + +前往 [Releases](https://github.com/yunyun-3782/GoodPlanCraftLaunCher/releases/) 下载对可执行文件。 + +## 使用 + +### 源 +```cmd +cd 项目根文件夹 + +#启动 GPCL +npm run start + +#编译、构建 GPCL +npm run build +``` + +### 预编译版本 + +```bash +#直接打开可执行(如.exe)文件 +``` + +## 贡献 + +欢迎提交 不同意见,同时欢迎开发 衍生 版本。 + +## 许可证 + +本项目采用 [CaelLab BY-SA Code License](https://www.caellab.com/license/bysa-code) 授权。 + +``` +CaelLab BY-SA Code License +Copyright (c) 2026 Yunyun(云云) By 虚舟实验室(CaelLab) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this work (the "Work"), to use, copy, modify, merge, publish, distribute, +sublicense, and/or sell copies of the Work, for personal, commercial, or +non-commercial purposes, subject to the following conditions: + +1. Source Availability: If you distribute the Work, or any derivative work + based on the Work, you must make the complete corresponding source code + available under the terms of this same license. + +2. License Preservation: The above copyright notice and this permission notice + shall be included in all copies or substantial portions of the Work. + +3. ShareAlike: Any distributed derivative work must be licensed under the + CaelLab BY-SA Code License. + +THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +``` + +--- + +**GoodPlanCraftLaunCher** — 让 Minecraft 启动更简单。