summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2025-10-30 09:24:14 +0800
committer魏曹先生 <1992414357@qq.com>2025-10-30 09:24:14 +0800
commitea9d988c98cbc0367361fa2d24eb474e642f3bf6 (patch)
treee96a9b81837f5d5e8435a5e801879bc6bdc3b6ec
parent4f35da85641549c3e08c4e1b73fccfc7ec9779a2 (diff)
Enhance README with branding and visual elements
- Add header images and badges for better visual presentation - Restructure both English and Chinese READMEs with consistent formatting - Include new image assets for project branding - Add table of contents sections for better navigation - Update warning messages to be more informative
-rw-r--r--README.md27
-rw-r--r--README_zh_CN.md31
-rw-r--r--docs/images/Background.pngbin0 -> 1209 bytes
-rw-r--r--docs/images/Header.pngbin0 -> 1491 bytes
-rw-r--r--docs/images/Header_Large.pngbin0 -> 7639 bytes
-rw-r--r--docs/images/Yizi.pngbin0 -> 322 bytes
-rw-r--r--docs/images/Yizi_Large.pngbin0 -> 21040 bytes
7 files changed, 44 insertions, 14 deletions
diff --git a/README.md b/README.md
index b6995b3..ac603c5 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,35 @@
-# Just Enough VCS
+<p align="center">
+ <a href="https://github.com/JustEnoughVCS/VersionControl">
+ <img alt="JustEnoughVCS" src="docs/images/Header_Large.png" width="100%">
+ </a>
+</p>
-> A Lightweight, Cross-Functional, Binary-Friendly Centralized VCS.
+<h1 align="center">JustEnoughVCS</h1>
+
+<p align="center">
+ A Lightweight, Cross-Functional, Binary-Friendly Centralized VCS.
+</p>
+
+<p align="center">
+ <img src="https://img.shields.io/github/stars/JustEnoughVCS/VersionControl?style=for-the-badge">
+ <img src="https://img.shields.io/badge/Status-Development%20in%20Progress-yellow?style=for-the-badge">
+ <img src="https://img.shields.io/badge/Release-Not%20Available-lightgrey?style=for-the-badge">
+</p>
> [!WARNING]
-> JustEnoughVCS is currently under active development.
+> JustEnoughVCS is currently under active development, and features are not yet complete.
>
-> This software is in the development stage, and its features are not yet complete.
+> If you are interested in our project, we recommend contacting us directly.
​ `JustEnoughVCS` is a lightweight version control system designed for **cross-functional teams**. It allows each member to view and organize files in a file structure **best suited to their functional role**, enabling the team to focus on content creation itself. It primarily serves collaborative scenarios involving large volumes of binary assets, such as **game development** and **multimedia design**.
+- [Virtual File System](#virtual-file-system)
+- [Sheet System](#sheet-system)
+
## My Design Philosophy - Also My Humble Opinion 😃
​ `JustEnoughVCS` adheres to the "**Just Enough**" philosophy, aiming to achieve collaborative security through architectural design. Centered around a **Virtual File System** and **Sheet Isolation**, it provides each creator with a focused, distraction-free workspace, making collaboration natural and simple.
-![img](docs/images/FRAMEWORK_CANVAS.png)
-
## Virtual File System
​ The Virtual File System is the foundation of `JustEnoughVCS`. Each file is identified by a globally unique `VirtualFileId`, decoupled from its physical path. It comprehensively records:
diff --git a/README_zh_CN.md b/README_zh_CN.md
index 787aae8..64eccf4 100644
--- a/README_zh_CN.md
+++ b/README_zh_CN.md
@@ -1,21 +1,36 @@
-# Just Enough VCS
+<p align="center">
+ <a href="https://github.com/JustEnoughVCS/VersionControl">
+ <img alt="JustEnoughVCS" src="docs/images/Header_Large.png" width="100%">
+ </a>
+</p>
-> 轻量、跨职能、二进制友好的集中式版本控制系统
+<h1 align="center">JustEnoughVCS</h1>
+
+<p align="center">
+ 轻量、跨职能、二进制友好的集中式版本控制系统
+</p>
+
+<p align="center">
+ <img src="https://img.shields.io/github/stars/JustEnoughVCS/VersionControl?style=for-the-badge">
+ <img src="https://img.shields.io/badge/Status-Development%20in%20Progress-yellow?style=for-the-badge">
+ <img src="https://img.shields.io/badge/Release-Not%20Available-lightgrey?style=for-the-badge">
+</p>
> [!WARNING]
-> JustEnoughVCS 目前正在积极开发中。
+> JustEnoughVCS 目前正在积极开发中,功能尚不完整
>
-> 本软件处于开发阶段,功能尚不完整。
+> 若您对我们的项目感兴趣,推荐直接联系我们。
​ `JustEnoughVCS` 是一个为**跨职能团队**设计的轻量级版本控制系统。它允许每个成员以**最适合其职能角色**的文件结构查看和组织文件,使团队能够专注于内容创作本身。它主要服务于大量二进制资产的协作场景,如**游戏开发**和**多媒体设计**。
+- [虚拟文件系统](#虚拟文件系统)
+- [表系统](#表系统)
+
## 我的设计哲学 - 也是我的拙见 😃
​ `JustEnoughVCS` 遵循 "**Just Enough**" 的理念,旨在通过架构设计来实现协作安全。它以**虚拟文件系统**和**表隔离**为核心,为每个创作者提供专注、无干扰的工作空间,让协作变得自然且简单。
-![img](docs/images/FRAMEWORK_CANVAS.png)
-
-## 虚拟文件系统 (Virtual File System)
+## 虚拟文件系统
​ 虚拟文件系统是 `JustEnoughVCS` 的基础。每个文件由一个全局唯一的 `VirtualFileId` 标识,与其物理路径解耦。它全面记录:
@@ -31,7 +46,7 @@
- **无冲突协作**:严格遵守 **"先获取,后编辑"** 原则。文件对所有人**可见**但仅对持有者**可写**,从而防止冲突。
- **获取前验证**:在获取文件之前,本地文件的哈希值和版本号会被严格验证,以确保编辑从最新版本开始。
-## 表系统 (Sheet System)
+## 表系统
​ 表系统充当连接**虚拟文件**与成员**本地工作区**的桥梁。它建立从 `VirtualFileId` 到本地 `SheetPath` 的映射,为每个职能角色(例如,程序员、艺术家、设计师)或个体成员创建定制化的文件视图。
diff --git a/docs/images/Background.png b/docs/images/Background.png
new file mode 100644
index 0000000..61e5d7b
--- /dev/null
+++ b/docs/images/Background.png
Binary files differ
diff --git a/docs/images/Header.png b/docs/images/Header.png
new file mode 100644
index 0000000..545bafb
--- /dev/null
+++ b/docs/images/Header.png
Binary files differ
diff --git a/docs/images/Header_Large.png b/docs/images/Header_Large.png
new file mode 100644
index 0000000..a84018f
--- /dev/null
+++ b/docs/images/Header_Large.png
Binary files differ
diff --git a/docs/images/Yizi.png b/docs/images/Yizi.png
new file mode 100644
index 0000000..48e8399
--- /dev/null
+++ b/docs/images/Yizi.png
Binary files differ
diff --git a/docs/images/Yizi_Large.png b/docs/images/Yizi_Large.png
new file mode 100644
index 0000000..c82c320
--- /dev/null
+++ b/docs/images/Yizi_Large.png
Binary files differ