From 3158e5726f3f72247a76626a69764ab05d12ba80 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Wed, 17 Dec 2025 14:08:58 +0800
Subject: Update README branding and simplify project description
---
README.md | 69 ++++++++++++++++++++++-----------------------------------
README_zh_CN.md | 60 +++++++++++++++++++------------------------------
2 files changed, 50 insertions(+), 79 deletions(-)
diff --git a/README.md b/README.md
index d2903b1..bcedff7 100644
--- a/README.md
+++ b/README.md
@@ -7,60 +7,50 @@
JustEnoughVCS
- Lightweight and Binary-Friendly Centralized Version Control System
+ Making version control easier than breathing!
+
-
+
-> [!WARNING]
-> JustEnoughVCS core features are still under development and not yet usable
->
-> If you are interested in our project, we recommend contacting us directly. [Contact and Support](#Support)
+## Introduction
+If you are looking for a version control system that your team members can easily get started with, we highly recommend you give this a try. This version control system lives up to its name: "Just Enough," providing just what you need without creating excessive mental overhead.
-## Introduction
-JustEnoughVCS simplifies binary collaboration by allowing only one person to edit a file at a time. Its architecture keeps you updated on file status, versions, and other relevant information.
-### 1. Personal View
+## Architecture
-Each member has their own sheet[^sheet] that maps assets to directory structures. This allows personalized file views. Members can focus on their own workspace without worrying about others moving files or affecting others with their own moves.
+`JustEnoughVCS` is a **centralized** version control system, divided into two parts: the **client** and the **server**.
-### 2. Asset "Read" and "Write"
+> [!NOTE]
+>
+> This version control system addresses the problem of managing the structure and versions of binary assets and is not suitable for managing code and text.
+>
+> In the realm of code and text, there are other extremely mature and widely recognized SCM systems.
-JustEnoughVCS has an intuitive permission model: visible assets can be read, held assets can be modified.
-[^sheet]: Sheet: A member's personal file structure. Members can have multiple sheets, but only one can be edited in a local workspace[^local_workspace] at a time.
-[^local_workspace]: Local Workspace: The local directory where members edit files.
-### 3. Visibility Propagation
+## Multi-File Structure
-To **share an asset with everyone**, export[^export] its mapping to the reference sheet[^ref_sheet]. After vault[^vault] administrator approval, it becomes visible to all members, who can then import[^import] it to receive updates.
+It encourages users to place and manage their assets in their preferred way and share the **visibility** of files with other team members as needed. Since each member has their own structure, there's no need to worry about file moves affecting others.
-To share with **specific sheets**, export the asset visibility to those sheets. After approval from the sheet holders, they can receive your updates.
-[^export]: Export: The method for transferring asset mappings in JVCS.
-[^import]: Import: The method for obtaining asset mappings in JVCS.
-[^ref_sheet]: Reference Sheet: A sheet curated by the vault[^vault] administrator, serving as the team's "asset index".
-[^vault]: Vault: The asset repository in JVCS where all assets are stored.
-### 4. Editing Rights Transfer
+## Serialized Editing
-The first member to track an asset becomes its initial holder with full editing rights. To transfer rights, the holder releases them, allowing another member to hold the asset. The latest version is synchronized during this process.
+At the same time, `JustEnoughVCS` manages permissions at the file granularity. At any given moment, only one member holds a file, meaning they have the **editing rights** for that file. After updating a file version, other members can discover the new version during the next status check and decide whether to update the latest version to their local workspace.
-> [!NOTE]
->
-> This collaboration model manages binary asset structure and versioning, but is not suitable for program development.
->
-> Git already serves that purpose well.
+## Rejecting Ambiguous Mappings
+When there is a **discrepancy** between the actual file structure and the recorded file structure, `JustEnoughVCS` will prevent you from tracking the file's version. You need to clearly explain your local structural changes before you can proceed.
## Roadmap
@@ -68,29 +58,24 @@ The first member to track an asset becomes its initial holder with full editing
### Core Library
- [ ] Incremental file updates and storage
-- [ ] Multiple reference sheets
+- [ ] Multiple reference tables
### Extension Tools
-- [ ] Command Line Tool -> [CommandLine](https://github.com/JustEnoughVCS/CommandLine ) (Currently Private)
-- [ ] Declarative Asset Management -> [AssetsConfig](https://github.com/JustEnoughVCS/AssetsConfig) (Currently Private)
-- [ ] File Merger -> [BinMerger](https://github.com/JustEnoughVCS/BinMerger) (Currently Private)
+- [x] Command-line client -> [CommandLine](https://github.com/JustEnoughVCS/CommandLine )
+- [ ] Desktop client -> [JVDesktop](https://github.com/JustEnoughVCS/JVDesktop )
+- [ ] Declarative asset management -> [JVRefs](https://github.com/JustEnoughVCS/AssetsConfig) (Currently Private)
+- [ ] File merger -> [JVBinMerger](https://github.com/JustEnoughVCS/BinMerger) (Currently Private)
## Support
-Encountered issues or have suggestions while using JustEnoughVCS?
-
-- Please submit them to https://github.com/JustEnoughVCS/VersionControl/issues, and we'll address your feedback promptly.
+Encountering any issues or have suggestions while using JustEnoughVCS?
-> [!NOTE]
->
-> The project is in early development. Instead of creating Issues, we recommend contacting [@Weicao-CatilGrass](https://github.com/Weicao-CatilGrass) directly.
->
-> Creating Issues will be more appropriate once basic features are more complete.
+- Please submit them to the https://github.com/JustEnoughVCS/VersionControl/issues page. We will promptly address your feedback.
@@ -98,8 +83,8 @@ Encountered issues or have suggestions while using JustEnoughVCS?
This project is licensed under the **MIT License**.
-For complete license terms, see ./LICENSE-MIT.md in the project root.
+For the full license terms, please refer to the ./LICENSE-MIT.md file in the project root directory.
---
-Thank you for your interest in `JustEnoughVCS`!
+Finally, thank you for your interest in `JustEnoughVCS`!
diff --git a/README_zh_CN.md b/README_zh_CN.md
index 9e750e2..6f7a495 100644
--- a/README_zh_CN.md
+++ b/README_zh_CN.md
@@ -7,59 +7,50 @@
JustEnoughVCS
- 轻量且二进制友好的集中式版本控制系统
+ 让版本控制比呼吸还简单!
+
-
+
-> [!WARNING]
-> JustEnoughVCS 核心功能仍在开发,还不是可使用的状态
->
-> 若您对我们的项目感兴趣,推荐直接联系我们。[联系方式和支持](#支持)
+## 写在开头
+如果您正在寻找一款让您团队成员可以轻松上手的版本控制,那么我们非常推荐您尝试一下。这款版本控制正如其名字讲述的那样:“刚好够用”,不产生过多的心智负担。
-## 简介
-一个文件同时只允许一人修改,这是二进制协作中最不容易出错的范式。JustEnoughVCS 将这种范式通过架构设计简化到极致。你可以随时掌握所关注文件的编辑状态、版本历史等信息。
-### 1. 个人视图
+## 架构
-每位成员拥有自己的表[^sheet],通过表来映射资产内容与目录结构。让每位成员看到的文件结构各不相同,成员只需关注自己工作区中的资产位置,无需担心资产被他人移动,也不会因自己的移动操作影响他人。
+`JustEnoughVCS` 是一款 **集中式** 的版本控制,分为 **客户端** 和 **服务端** 两个部分。
-### 2. 资产的 “读” 和 “写”
+> [!NOTE]
+>
+> 该版本控制解决的是二进制资产的结构和版本管理的问题,不适合管理代码和文本。
+>
+> 在代码和文本领域,有极为成熟且被认可的其他 SCM 系统。
-JustEnoughVCS 的权限模型非常直观:如果你看得见该资产,你就可以读取它;如果你持有该资产,则可以修改它。
-[^sheet]: 表(Sheet),成员个人的文件结构,一位成员可以持有多个表,但一个本地工作区[^local_workspace]仅允许同时编辑一个。
-[^local_workspace]: 本地工作区(Local Workspace),资产的本地拷贝目录,用以在成员的本地编辑文件。
-### 3. 可读性传播
+## 多文件结构
-JustEnoughVCS 中,若您要将资产 **共享给所有人**,需要将该资产的映射导出[^export] 至参照表[^ref_sheet],由库[^vault]管理员确认后将其公开展示给所有成员。之后所有成员都可以从参照表[^ref_sheet]中导入[^import]该资产的映射,以获取最新的更新。
+它鼓励用户以习惯的方式去放置、管理自己的资产,并按需将文件的 **可见性** 分享给团队内的其他成员。正因每位成员都有自己的结构,也不必担心文件的移动会影响他人。
-若您只是需要共享给 **指定的表**,和上述逻辑一致,将资产可见性导出至该表,由该表的持有者确认后,则可以接收到您的文件更新。
-[^export]: 导出(Export)是 JVCS 中资产映射的传递方式。
-[^import]: 导入(Import)是 JVCS 中获得资产映射的方式。
-[^ref_sheet]: 参照表(Reference Sheet)是由库[^vault]管理员所整理的表,团队中的 ”资产索引“
-[^vault]: 库(Vault)是 JVCS 中的资产仓库,所有的资产存放于此。
-### 4. 编辑权转移
+## 串行编辑
-一般来讲,资产的最初持有者是第一个追踪该资产的成员,该成员拥有绝对的资产编辑权。若该成员需要将编辑权转移给其他人,只需 ”放弃“ 编辑权,再由其他成员 ”持有“ ,此过程中会同步资产的最新进度,以确保持有该资产的成员正编辑的资产是最新的。
+同时,`JustEnoughVCS` 以文件为粒度进行权限管理,在同一时刻内,只有一名成员持有该文件,即拥有文件的 **编辑权**。在更新文件版本后,其他成员可在下次状态检查时发现新版本,并决定是否将最新版本更新到本地。
-> [!NOTE]
->
-> 该协作范式解决的是二进制资产的结构和版本管理的问题,不适合作为程序开发的版本控制系统。
->
-> 因为该领域有极为成熟且被认可的 Git。
+## 拒绝模糊映射
+
+在实际文件结构与记录的文件结构有 **偏差** 时,`JustEnoughVCS` 将会禁止您追踪文件的版本,您需要解释清楚您本地的结构变动才能继续。
@@ -74,9 +65,10 @@ JustEnoughVCS 中,若您要将资产 **共享给所有人**,需要将该资
### 拓展工具
-- [ ] 命令行工具 -> [CommandLine](https://github.com/JustEnoughVCS/CommandLine )(目前 Private)
-- [ ] 声明式资产管理 -> [AssetsConfig](https://github.com/JustEnoughVCS/AssetsConfig) (目前 Private)
-- [ ] 文件合并器 -> [BinMerger](https://github.com/JustEnoughVCS/BinMerger) (目前 Private)
+- [x] 命令行客户端 -> [CommandLine](https://github.com/JustEnoughVCS/CommandLine )
+- [ ] 桌面客户端 -> [JVDesktop](https://github.com/JustEnoughVCS/JVDesktop )
+- [ ] 声明式资产管理 -> [JVRefs](https://github.com/JustEnoughVCS/AssetsConfig) (目前 Private)
+- [ ] 文件合并器 -> [JVBinMerger](https://github.com/JustEnoughVCS/BinMerger) (目前 Private)
@@ -86,12 +78,6 @@ JustEnoughVCS 中,若您要将资产 **共享给所有人**,需要将该资
- 请将其提交到 https://github.com/JustEnoughVCS/VersionControl/issues 页面,我们将及时处理您的反馈。
-> [!NOTE]
->
-> 当前项目仍在早期开发阶段,比起发起 Issues,我更建议您直接联系仓库维护者 [@Weicao-CatilGrass](https://github.com/Weicao-CatilGrass)
->
-> 待基础功能完善后,再发起 Issues 会更加合适
-
## 许可证
--
cgit