You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-2Lines changed: 51 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,17 @@
8
8
9
9
---
10
10
11
+
## 🚀 Why Use CodeSleuth?
12
+
13
+
Enterprise COBOL codebases are often large, undocumented, and hard to modernize. CodeSleuth automates structural analysis, dead code detection, and documentation — helping teams audit, refactor, or migrate legacy COBOL more confidently.
14
+
15
+
---
16
+
17
+
> **Note:**
18
+
> This is the `main` branch. It currently uses a single-threaded Go CLI and separate Rust parser/summarizer binaries. **Unified backend and concurrency are available on the [`feat/concurrency-worker-pool`](https://github.com/Cod-e-Codes/codesleuth/tree/feat/concurrency-worker-pool) branch and will be merged soon.**
19
+
20
+
---
21
+
11
22
## Features
12
23
13
24
-**COBOL Parsing:** Rust-based parser for extracting program structure and metadata
@@ -26,6 +37,38 @@
26
37
-**Rust Summarizer** (`summarizer/`): Consumes IR and generates Markdown reports
27
38
-**Go CLI** (`cmd/`): Orchestrates parsing and summarization, providing a user-facing CLI
28
39
40
+
> **Upcoming:**
41
+
> The next release will unify the Rust backend and add concurrent file analysis, as already available on the feature branch.
42
+
43
+
---
44
+
45
+
## 🔧 Project Status
46
+
47
+
This is a **work-in-progress alpha**. The `main` branch is stable for single-file and small-batch COBOL analysis. **Unified backend and concurrency are being actively tested on the feature branch and will be merged after further bug fixes.**
48
+
49
+
---
50
+
51
+
## 📄 Example Output
52
+
53
+
```markdown
54
+
# COBOL Program Summary
55
+
56
+
**Program Name:** PAYROLL01
57
+
**Author:** Jane Doe
58
+
**Working-Storage:** 28 variables
59
+
**Dead Code Detected:** 3 paragraphs
60
+
61
+
## Control Flow
62
+
63
+
```
64
+
65
+
```mermaid
66
+
graph TD
67
+
Start --> Validate
68
+
Validate --> Process
69
+
Process --> End
70
+
```
71
+
29
72
---
30
73
31
74
## Installation
@@ -70,6 +113,12 @@ cd cmd && go build -o codesleuth && cd ..
0 commit comments