Skip to content

Commit ca35d5c

Browse files
committed
adjust readme
1 parent a28f70c commit ca35d5c

1 file changed

Lines changed: 14 additions & 47 deletions

File tree

README.md

Lines changed: 14 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ Developers spend **58% of their working time** understanding codebases, yet main
5353

5454
CodeWiki has been evaluated on the **CodeWikiBench** dataset, the first benchmark specifically designed for repository-level documentation quality assessment.
5555

56-
| Language Category | CodeWiki Avg | Improvement over Baseline |
56+
| Language Category | CodeWiki Avg | Improvement over DeepWiki |
5757
|-------------------|--------------|---------------------------|
5858
| High-Level (Python, JS, TS) | **79.14%** | +10.47% |
5959
| Managed (C#, Java) | **68.84%** | +4.04% |
6060
| Systems (C, C++) | 53.24% | -3.15% |
6161
| **Overall Average** | **68.79%** | **+4.73%** |
6262

63-
CodeWiki demonstrates significant improvements in high-level and managed languages, with an overall 4.73% improvement over baseline approaches.
63+
CodeWiki demonstrates significant improvements in high-level and managed languages, with an overall 4.73% improvement over [DeepWiki](https://deepwiki.com/).
6464

6565
---
6666

@@ -79,19 +79,26 @@ CodeWiki demonstrates significant improvements in high-level and managed languag
7979
git clone https://github.com/yourusername/codewiki.git
8080
cd codewiki
8181

82+
# Install Node.js (if not already installed)
83+
# macOS
84+
brew install node
85+
# Linux
86+
sudo apt update && apt install -y nodejs npm
87+
8288
# Create and activate virtual environment
8389
python3.12 -m venv .venv
8490
source .venv/bin/activate # On Windows: .venv\Scripts\activate
8591

8692
# Install dependencies
8793
pip install -r requirements.txt
8894

89-
# Install Node.js (if not already installed)
90-
# macOS
91-
brew install node
95+
#Create a `.env` file from the template and edit with your configuration
96+
cp env.example .env
9297

93-
# Linux
94-
sudo apt update && apt install -y nodejs npm
98+
# Start the web application
99+
python run_web_app.py
100+
101+
#Access the application at `http://localhost:8000` to generate documentation by github url and commit id (optional)
95102
```
96103

97104
### Docker Installation
@@ -110,46 +117,6 @@ docker-compose up -d
110117

111118
---
112119

113-
## Quick Start
114-
115-
### 1. Configure API Keys
116-
117-
Create a `.env` file from the template:
118-
119-
```bash
120-
cp env.example .env
121-
```
122-
123-
Edit `.env` with your configuration:
124-
125-
```bash
126-
# LLM Configuration
127-
MAIN_MODEL=claude-sonnet-4
128-
FALLBACK_MODEL_1=glm-4p5
129-
LLM_BASE_URL=http://litellm:4000/
130-
LLM_API_KEY=your-api-key-here
131-
132-
# Application
133-
APP_PORT=8000
134-
135-
# Optional: Logfire for monitoring
136-
LOGFIRE_TOKEN=your-logfire-token
137-
```
138-
139-
### 2. Run the Web Application
140-
141-
```bash
142-
# Activate virtual environment
143-
source .venv/bin/activate
144-
145-
# Start the web application
146-
python run_web_app.py
147-
```
148-
149-
Access the application at `http://localhost:8000` to generate documentation by github url and commit id (optional)
150-
151-
---
152-
153120
## Workflow
154121

155122
```mermaid

0 commit comments

Comments
 (0)