Skip to content

Commit 7d5e736

Browse files
YAYLABS-Snooclaude
andcommitted
Clarify CodeSyncer's role: Framework provider for AI-assisted setup
- Updated README to clearly explain the workflow: 1. Install CodeSyncer 2. Launch AI assistant (Claude Code, etc.) 3. Run codesyncer init 4. AI analyzes and generates docs following CodeSyncer's structure - Added 'Prerequisites' section emphasizing AI requirement - Clarified that CodeSyncer provides WHERE/HOW, AI provides WHAT - Updated Quick Start to show step-by-step process - Both English and Korean READMEs updated CodeSyncer is a framework/structure provider, not a standalone analyzer. AI assistants do the actual code analysis and content generation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 06b649b commit 7d5e736

2 files changed

Lines changed: 104 additions & 8 deletions

File tree

README.ko.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,15 @@
1313

1414
## 🎯 CodeSyncer란?
1515

16-
CodeSyncer는 여러 레포지토리에서 AI 코딩 어시스턴트와 효율적으로 협업할 수 있도록 도와주는 CLI 도구입니다. 프로젝트 구조, 코딩 규칙, 비즈니스 결정 사항을 체계적으로 문서화하여 AI가 이해할 수 있게 만듭니다.
16+
CodeSyncer는 AI 코딩 어시스턴트(Claude Code 등)가 멀티 레포지토리 워크스페이스에 지능형 협업 시스템을 구축할 수 있도록 **프레임워크와 규칙**을 제공합니다.
17+
18+
**작동 방식:**
19+
1. **사용자가** CodeSyncer CLI 설치
20+
2. **사용자가** AI 어시스턴트 실행 (Claude Code, Cursor 등)
21+
3. **사용자가** `codesyncer init` 실행
22+
4. **AI가** 프로젝트를 분석하고 CodeSyncer 구조에 따라 문서 생성
23+
24+
CodeSyncer는 문서가 **어디에, 어떻게** 만들어져야 하는지 정의합니다. AI 어시스턴트는 실제 코드를 분석하여 **무엇을** 작성할지 결정합니다.
1725

1826
### 주요 기능
1927

@@ -26,6 +34,20 @@ CodeSyncer는 여러 레포지토리에서 AI 코딩 어시스턴트와 효율
2634

2735
---
2836

37+
## ⚠️ 사전 요구사항
38+
39+
**CodeSyncer는 AI 코딩 어시스턴트가 활성화되어 있어야 합니다.**
40+
41+
현재 지원:
42+
-**Claude Code** (권장)
43+
- 🚧 Cursor (곧 지원 예정)
44+
- 🚧 GitHub Copilot (곧 지원 예정)
45+
- 🚧 Continue.dev (곧 지원 예정)
46+
47+
**중요**: CodeSyncer를 사용하기 전에 AI 코딩 어시스턴트를 **실행하고 활성화**해주세요. AI가 프로젝트를 분석하고 정확한 문서를 생성하는 데 도움을 줍니다.
48+
49+
---
50+
2951
## 📦 설치
3052

3153
```bash
@@ -57,7 +79,23 @@ npm install -g codesyncer@latest
5779

5880
## 🚀 빠른 시작
5981

60-
### 1. 워크스페이스 루트로 이동
82+
### 1단계: CodeSyncer 설치
83+
84+
```bash
85+
npm install -g codesyncer
86+
```
87+
88+
### 2단계: AI 어시스턴트 실행
89+
90+
AI 코딩 어시스턴트를 실행하세요:
91+
- **Claude Code** (권장)
92+
- Cursor
93+
- GitHub Copilot
94+
- 또는 다른 AI 코딩 도구
95+
96+
반드시 **활성화되어 실행 중**이어야 합니다.
97+
98+
### 3단계: 워크스페이스로 이동
6199

62100
```bash
63101
cd /path/to/your/workspace
@@ -71,13 +109,23 @@ workspace/
71109
└── mobile/
72110
```
73111

74-
### 2. 초기화 실행
112+
### 4단계: CodeSyncer 초기화
75113

76114
```bash
77115
codesyncer init
78116
```
79117

80-
### 3. 설치 모드 선택
118+
**실행 과정:**
119+
1. CodeSyncer가 문서 프레임워크 생성
120+
2. AI 어시스턴트가 각 레포지토리 분석
121+
3. AI가 CodeSyncer 구조에 따라 문서 생성:
122+
- `.codesyncer/MASTER_CODESYNCER.md` (워크스페이스 루트)
123+
- `<repo>/.claude/CLAUDE.md` (코딩 가이드라인)
124+
- `<repo>/.claude/ARCHITECTURE.md` (프로젝트 구조)
125+
- `<repo>/.claude/DECISIONS.md` (의사결정 기록)
126+
- `<repo>/.claude/COMMENT_GUIDE.md` (주석 태그 가이드)
127+
128+
### 5단계: 설정 모드 선택
81129

82130
**⚡ 퀵 설치** (권장)
83131
- 모든 레포 자동 감지

README.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,15 @@
1313

1414
## 🎯 What is CodeSyncer?
1515

16-
CodeSyncer is a CLI tool that sets up an intelligent collaboration system between you and AI coding assistants across multiple repositories. It helps AI understand your project structure, coding standards, and business decisions through a structured documentation system.
16+
CodeSyncer provides the **framework and rules** for AI coding assistants (like Claude Code) to set up an intelligent collaboration system across your multi-repository workspace.
17+
18+
**How it works:**
19+
1. **You install** CodeSyncer CLI
20+
2. **You launch** your AI assistant (Claude Code, Cursor, etc.)
21+
3. **You run** `codesyncer init`
22+
4. **AI analyzes** your projects and generates documentation following CodeSyncer's structure
23+
24+
CodeSyncer defines **WHERE** and **HOW** documentation should be created. Your AI assistant fills in the **WHAT** by analyzing your actual code.
1725

1826
### Key Features
1927

@@ -26,6 +34,20 @@ CodeSyncer is a CLI tool that sets up an intelligent collaboration system betwee
2634

2735
---
2836

37+
## ⚠️ Prerequisites
38+
39+
**CodeSyncer requires an AI coding assistant to be active.**
40+
41+
Currently supported:
42+
-**Claude Code** (Recommended)
43+
- 🚧 Cursor (Coming soon)
44+
- 🚧 GitHub Copilot (Coming soon)
45+
- 🚧 Continue.dev (Coming soon)
46+
47+
**Important**: Make sure your AI coding assistant is **running and active** before using CodeSyncer. The AI will analyze your projects and help generate accurate documentation.
48+
49+
---
50+
2951
## 📦 Installation
3052

3153
```bash
@@ -57,7 +79,23 @@ npm install -g codesyncer@latest
5779

5880
## 🚀 Quick Start
5981

60-
### 1. Navigate to your workspace root
82+
### Step 1: Install CodeSyncer
83+
84+
```bash
85+
npm install -g codesyncer
86+
```
87+
88+
### Step 2: Launch your AI assistant
89+
90+
Open your AI coding assistant:
91+
- **Claude Code** (Recommended)
92+
- Cursor
93+
- GitHub Copilot
94+
- Or any other AI coding tool
95+
96+
Make sure it's **active and running**.
97+
98+
### Step 3: Navigate to your workspace
6199

62100
```bash
63101
cd /path/to/your/workspace
@@ -71,13 +109,23 @@ workspace/
71109
└── mobile/
72110
```
73111

74-
### 2. Run initialization
112+
### Step 4: Initialize CodeSyncer
75113

76114
```bash
77115
codesyncer init
78116
```
79117

80-
### 3. Choose setup mode
118+
**What happens:**
119+
1. CodeSyncer creates the documentation framework
120+
2. Your AI assistant analyzes each repository
121+
3. AI generates documentation following CodeSyncer's structure:
122+
- `.codesyncer/MASTER_CODESYNCER.md` (workspace root)
123+
- `<repo>/.claude/CLAUDE.md` (coding guidelines)
124+
- `<repo>/.claude/ARCHITECTURE.md` (project structure)
125+
- `<repo>/.claude/DECISIONS.md` (decision log)
126+
- `<repo>/.claude/COMMENT_GUIDE.md` (comment tag guide)
127+
128+
### Step 5: Choose setup mode
81129

82130
**⚡ Quick Setup** (Recommended)
83131
- Auto-detects all repositories

0 commit comments

Comments
 (0)