Skip to content

Commit

Permalink
添加readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Wulian233 committed May 26, 2024
1 parent 4472336 commit 1832902
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vitepress/config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export default defineConfig({
root: { label: '简体中文', ...zh },
tw: { label: '繁體中文', ...tw }
},
srcExclude: ['**/readme.md', '**/LICENSE', '**/.gitignore'],

lastUpdated: true,
cleanUrls: true,
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Wulian233

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE 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. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
50 changes: 50 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<div align="center"><img height="150" src="public/img/vm.png" width="190"/></div>

# VM汉化组官方网站v3
主站点:[点击访问](https://beta.vmct-cn.top/)

评论分站:[点击访问](https://vm-comment.pp.ua/)
1. 源码仓库[点此跳转](https://github.com/Litchiiiiii/VM-Comment)
2. 生成仓库[点此跳转](https://github.com/Litchiiiiii/Litchiiiiii.github.io)


## 📖 什么是VM汉化组?

VM汉化组是一个用爱发电专注于汉化MC整合包与地图的非盈利组织。我们制作的汉化及相关技术最终目的是使公众收益,汉化组将寻求高质量永久免费汉化包以造福玩家。汉化组的成立不是为了任何人的私人利益。汉化组产生的所有收益将“不可撤销的”用于上述目的。

## 💧 目录介绍

```markdown
- vmct-website-beta
- .github 自动构建脚本
- .vitepress
- config vitepress的配置文件
- theme 自定义主题和组件
- map 地图页面
- modpacks 整合包页面
- others 其他页面
- public 存放静态文件如图片
- tw 繁体中文页面
- readme.md 自述文件
```

## 📖 使用与部署

本网站使用[Vitepress](https://vitepress.dev/zh/)作为静态站点生成器。我们推荐使用VSCode编辑器进行开发。

1. 安装[Node.js](https://nodejs.org/en/download/prebuilt-binaries)
2. 克隆仓库到本地
3. 在终端输入`npm install`安装依赖
4. 在终端输入`npm run dev`启动本地服务,可在浏览器预览


我们使用了一套完全免费的部署方案,可长期稳定运行:
1. 使用[github action](https://github.com/Wulian233/vmct-website-beta/blob/main/.github/workflows/build.yaml)提交自动触发构建为github pages。
2. 使用[CloudFlare](https://cloudflare.com/)作为免费CDN分发。
3.使用[路过图床](https://imgse.com/)手动上传作为图片存储。

PS:域名在腾讯云购买

## 👀 协议

本网站使用[MIT协议](LICENSE).

0 comments on commit 1832902

Please sign in to comment.