From 02672be45a6ee567dbe135464d0210c97cba1ef7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=99=88=E6=80=9D=E6=B5=B7?= <10001@qq.com>
Date: Thu, 23 Jan 2025 10:38:21 +0800
Subject: [PATCH] init

---
 LICENSE.md => LICENSE |  2 +-
 LICENSE.md.meta       |  3 ---
 LICENSE.meta          |  7 ++++++
 README.md             | 57 ++++++++++++++++++++++++++++---------------
 README.md.meta        |  8 ++++--
 README_zh.md          | 49 +++++++++++++++++++++++++++++++++++++
 README_zh.md.meta     |  7 ++++++
 7 files changed, 108 insertions(+), 25 deletions(-)
 rename LICENSE.md => LICENSE (95%)
 delete mode 100644 LICENSE.md.meta
 create mode 100644 LICENSE.meta
 create mode 100644 README_zh.md
 create mode 100644 README_zh.md.meta

diff --git a/LICENSE.md b/LICENSE
similarity index 95%
rename from LICENSE.md
rename to LICENSE
index f3828d5..5303ba7 100644
--- a/LICENSE.md
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Blank
+Copyright (c) 2023 Code Philosophy(代码哲学)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/LICENSE.md.meta b/LICENSE.md.meta
deleted file mode 100644
index e740473..0000000
--- a/LICENSE.md.meta
+++ /dev/null
@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: 65ab0fd9d052403ebdaead4404d96767
-timeCreated: 1702092259
\ No newline at end of file
diff --git a/LICENSE.meta b/LICENSE.meta
new file mode 100644
index 0000000..45660f0
--- /dev/null
+++ b/LICENSE.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 078e48d5b430a7d4db6745b56c27f8d5
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/README.md b/README.md
index ccb3105..1fbf786 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,49 @@
 
-# 非常强大的配置表解决方案
+- [README 中文](./README_zh.md)
+- [README English](./README.md)
 
-uban是一个强大、易用、优雅、稳定的游戏配置解决方案。它设计目标为满足从小型到超大型游戏项目的简单到复杂的游戏配置工作流需求。
+# Luban
 
-luban可以处理丰富的文件类型，支持主流的语言，可以生成多种导出格式，支持丰富的数据检验功能，具有良好的跨平台能力，并且生成极快。 luban有清晰优雅的生成管线设计，支持良好的模块化和插件化，方便开发者进行二次开发。开发者很容易就能将luban适配到自己的配置格式，定制出满足项目要求的强大的配置工具。
+![icon](docs/images/logo.png)
 
-luban标准化了游戏配置开发工作流，可以极大提升策划和程序的工作效率。
-
-该库主要服务于 `https://github.com/GameFrameX/GameFrameX` 作为子库使用。
+[![license](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT) ![star](https://img.shields.io/github/stars/focus-creative-games/luban?style=flat-square)
 
 
-# 使用方式(三种方式)
-1. 直接在 `manifest.json` 文件中添加以下内容
-   ```json
-      {"com.gameframex.unity.focus-creative-games.luban": "https://github.com/gameframex/com.gameframex.unity.focus-creative-games.luban.git"}
-    ```
-2. 在Unity 的`Packages Manager` 中使用`Git URL` 的方式添加库,地址为：https://github.com/gameframex/com.gameframex.unity.focus-creative-games.luban.git
+luban is a powerful, easy-to-use, elegant, and stable game configuration solution. It is designed to meet the needs of simple to complex game configuration workflows from small to very large game projects.
 
-3. 直接下载仓库放置到Unity 项目的`Packages` 目录下。会自动加载识别
+luban can handle a variety of file types, supports mainstream languages, can generate multiple export formats, supports rich data inspection functions, has good cross-platform capabilities, and generates extremely fast.
+Luban has a clear and elegant generation pipeline design, supports good modularization and plug-in, and is convenient for developers to carry out secondary development. Developers can easily adapt luban to their own configuration format, and customize powerful configuration tools that meet project requirements.
 
-# 改动功能
+Luban standardizes the game configuration development workflow, which can greatly improve the efficiency of planning and programming.
 
-1. 增加 `Packages` 的支持
-2. 移除ODIN 的依赖
-3. 增加防裁剪的帮助类。需要在启动的主场景中挂载 `LuBanCroppingHelper` 脚本即可
+## Core features
 
-# 使用文档
+- Rich source data format. Support excel family (csv, xls, xlsx, xlsm), json, xml, yaml, lua, etc.
+- Rich export formats. Support generating binary, json, bson, xml, lua, yaml and other format data
+- Enhanced excel format. Simple configurations such as simple lists, substructures, structured lists, and arbitrarily complex deep nested structures can be concisely configured
+- Complete type system. Not only can it express common specification line lists, but it can flexibly and elegantly express complex GamePlay data such as behavior trees, skills, plots, and dungeons because **supports OOP type inheritance**
+- Support multiple languages. Supports generating language codes such as c#, java, go, cpp, lua, python, typescript, etc.
+- Support mainstream message schemes. protobuf(schema + binary + json), flatbuffers(schema + json), msgpack(binary)
+- Powerful data verification capability. ref reference check, path resource path, range range check, etc.
+- Perfect localization support
+- Supports all major game engines and platforms. Support Unity, Unreal, Cocos2x, Godot, WeChat games, etc.
+- Good cross-platform capability. It can run well on Win, Linux, and Mac platforms.
+- Support all mainstream hot update solutions. hybridclr, ilruntime, {x,t,s}lua, puerts, etc.
+- Clear and elegant generation pipeline, it is easy to carry out secondary development on the basis of luban, and customize a configuration tool suitable for your own project style.
 
-https://luban.doc.code-philosophy.com/docs/intro
\ No newline at end of file
+## Documentation
+
+- [Luban](https://github.com/focus-creative-games/luban)
+- [Official Documentation](https://luban.doc.code-philosophy.com/)
+- [Quick Start](https://luban.doc.code-philosophy.com/docs/beginner/quickstart)
+- **Example Project** ([github](https://github.com/focus-creative-games/luban_examples)) ([gitee](https://gitee.com/focus-creative-games/luban_examples) )
+
+## Support and Contact
+
+- QQ group: 692890842 (Luban development exchange group)
+- discord: https://discord.gg/dGY4zzGMJ4
+- Email: luban#code-philosophy.com
+
+## license
+
+Luban is licensed under the [MIT](https://github.com/focus-creative-games/luban/blob/main/LICENSE) license
diff --git a/README.md.meta b/README.md.meta
index 0275d78..49e16c7 100644
--- a/README.md.meta
+++ b/README.md.meta
@@ -1,3 +1,7 @@
 fileFormatVersion: 2
-guid: 5c4f345aed3f4bbe89a61e801e26701a
-timeCreated: 1702092253
\ No newline at end of file
+guid: 3cefe9933a4e0e44e845f53b784d2fc6
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/README_zh.md b/README_zh.md
new file mode 100644
index 0000000..89b4268
--- /dev/null
+++ b/README_zh.md
@@ -0,0 +1,49 @@
+
+- [README 中文](./README_zh.md)
+- [README English](./README.md)
+
+# Luban
+
+![icon](docs/images/logo.png)
+
+[![license](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT) ![star](https://img.shields.io/github/stars/focus-creative-games/luban?style=flat-square)
+
+
+luban是一个强大、易用、优雅、稳定的游戏配置解决方案。它设计目标为满足从小型到超大型游戏项目的简单到复杂的游戏配置工作流需求。
+
+luban可以处理丰富的文件类型，支持主流的语言，可以生成多种导出格式，支持丰富的数据检验功能，具有良好的跨平台能力，并且生成极快。
+luban有清晰优雅的生成管线设计，支持良好的模块化和插件化，方便开发者进行二次开发。开发者很容易就能将luban适配到自己的配置格式，定制出满足项目要求的强大的配置工具。
+
+luban标准化了游戏配置开发工作流，可以极大提升策划和程序的工作效率。
+
+## 核心特性
+
+- 丰富的源数据格式。支持excel族(csv,xls,xlsx,xlsm)、json、xml、yaml、lua等
+- 丰富的导出格式。 支持生成binary、json、bson、xml、lua、yaml等格式数据
+- 增强的excel格式。可以简洁地配置出像简单列表、子结构、结构列表，以及任意复杂的深层次的嵌套结构
+- 完备的类型系统。不仅能表达常见的规范行列表，由于**支持OOP类型继承**，能灵活优雅表达行为树、技能、剧情、副本之类复杂GamePlay数据
+- 支持多种的语言。支持生成c#、java、go、cpp、lua、python、typescript 等语言代码
+- 支持主流的消息方案。 protobuf(schema + binary + json)、flatbuffers(schema + json)、msgpack(binary)
+- 强大的数据校验能力。ref引用检查、path资源路径、range范围检查等等
+- 完善的本地化支持
+- 支持所有主流的游戏引擎和平台。支持Unity、Unreal、Cocos2x、Godot、微信小游戏等
+- 良好的跨平台能力。能在Win,Linux,Mac平台良好运行。
+- 支持所有主流的热更新方案。hybridclr、ilruntime、{x,t,s}lua、puerts等
+- 清晰优雅的生成管线，很容易在luban基础上进行二次开发，定制出适合自己项目风格的配置工具。
+
+## 文档
+
+- [Luban](https://github.com/focus-creative-games/luban)
+- [官方文档](https://luban.doc.code-philosophy.com/)
+- [快速上手](https://luban.doc.code-philosophy.com/docs/beginner/quickstart)
+- **示例项目** ([github](https://github.com/focus-creative-games/luban_examples)) ([gitee](https://gitee.com/focus-creative-games/luban_examples))
+
+## 支持与联系
+
+ - QQ群: 692890842 （Luban开发交流群）
+ - discord: https://discord.gg/dGY4zzGMJ4
+ - 邮箱: luban#code-philosophy.com
+
+## license
+
+Luban is licensed under the [MIT](https://github.com/focus-creative-games/luban/blob/main/LICENSE) license
diff --git a/README_zh.md.meta b/README_zh.md.meta
new file mode 100644
index 0000000..602ddd4
--- /dev/null
+++ b/README_zh.md.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: a673262afcffe1d4a920ae8401c26bef
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: