Skip to content

Commit b43dd1e

Browse files
bdqnghiclaude
andcommitted
Update README badges and title
- Remove non-existent CI and PyPI badges - Add arXiv badge with paper ID - Restore full paper title in header - Move framework figure below header section - Remove PyPI installation instructions since package doesn't exist 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 60382f4 commit b43dd1e

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
<p align="center">
2-
<img src="./img/framework-overview.png" alt="CodeWiki Framework" width="500" style="border: 2px solid #e1e4e8; border-radius: 12px; padding: 20px;"/>
3-
</p>
4-
5-
<h1 align="center">CodeWiki</h1>
1+
<h1 align="center">CodeWiki: Evaluating AI's Ability to Generate Holistic Documentation for Large-Scale Codebases</h1>
62

73
<p align="center">
84
<strong>AI-Powered Repository Documentation Generation</strong> • <strong>Multi-Language Support</strong> • <strong>Architecture-Aware Analysis</strong>
@@ -13,11 +9,10 @@
139
</p>
1410

1511
<p align="center">
16-
<a href="https://github.com/FSoft-AI4Code/CodeWiki/actions"><img alt="CI" src="https://github.com/FSoft-AI4Code/CodeWiki/actions/workflows/ci.yml/badge.svg" /></a>
17-
<a href="https://pypi.org/project/codewiki/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/codewiki?style=flat-square" /></a>
1812
<a href="https://python.org/"><img alt="Python version" src="https://img.shields.io/badge/python-3.12+-blue?style=flat-square" /></a>
1913
<a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-green.svg?style=flat-square" /></a>
2014
<a href="https://github.com/FSoft-AI4Code/CodeWiki/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/FSoft-AI4Code/CodeWiki?style=flat-square" /></a>
15+
<a href="https://arxiv.org/abs/2510.24428"><img alt="arXiv" src="https://img.shields.io/badge/arXiv-2510.24428-b31b1b?style=flat-square" /></a>
2116
</p>
2217

2318
<p align="center">
@@ -27,17 +22,18 @@
2722
<a href="https://arxiv.org/abs/2510.24428"><strong>Paper</strong></a>
2823
</p>
2924

25+
<p align="center">
26+
<img src="./img/framework-overview.png" alt="CodeWiki Framework" width="600" style="border: 2px solid #e1e4e8; border-radius: 12px; padding: 20px;"/>
27+
</p>
28+
3029
---
3130

3231
## Quick Start
3332

3433
### 1. Install CodeWiki
3534

3635
```bash
37-
# Install from PyPI
38-
pip install codewiki
39-
40-
# Or install from source
36+
# Install from source
4137
pip install git+https://github.com/FSoft-AI4Code/CodeWiki.git
4238

4339
# Verify installation

0 commit comments

Comments
 (0)