Skip to content

Commit 7e2d1a2

Browse files
committed
docs: update README to be factual, dev-oriented, and remove unsubstantiated claims
1 parent 54cb5de commit 7e2d1a2

File tree

1 file changed

+29
-49
lines changed

1 file changed

+29
-49
lines changed

README.md

Lines changed: 29 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,31 @@
44
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
55
[![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-Contributor%20Covenant-blueviolet.svg)](CODE_OF_CONDUCT.md)
66

7-
**CodeSleuth** is a high-performance, multi-language code intelligence CLI tool designed for legacy COBOL analysis. Built with Rust and Go, it provides fast parsing, comprehensive analysis, and actionable insights for enterprise codebases.
7+
**CodeSleuth** is a code intelligence CLI tool for analyzing legacy COBOL codebases. It is built with Rust and Go, providing a modular architecture for parsing, analysis, and reporting.
88

99
---
1010

11-
## 🚀 Features
11+
## Features
1212

13-
- **⚡ High-Performance Parsing:** Rust-based COBOL parser with 10-50x faster processing
14-
- **📊 Comprehensive Analysis:** Program structure, data division, procedure logic, call/control flow, and I/O analysis
15-
- **📝 Rich Markdown Reports:** Detailed summaries with Mermaid diagrams for call and control flow visualization
16-
- **🔍 Dead Code Detection:** Identifies unused paragraphs and variables
17-
- **🏗️ Modular Architecture:** Clean separation between parser, CLI, and summarizer components
18-
- **🔧 Modern CLI:** Intuitive command-line interface with verbose/debug options
19-
- **🛡️ Security Focused:** Comprehensive security policy and responsible disclosure
20-
- **🔄 CI/CD Ready:** Automated testing and linting via GitHub Actions
13+
- **COBOL Parsing:** Rust-based parser for extracting program structure and metadata
14+
- **Analysis & Summarization:** Generates Markdown reports with program structure, data division, procedure logic, call/control flow, and I/O analysis
15+
- **Dead Code Detection:** Identifies unused paragraphs and variables
16+
- **Call & Control Flow Visualization:** Mermaid diagrams for call and control flow
17+
- **Modern CLI:** Go-based command-line interface with verbose/debug options
18+
- **Cross-platform:** Runs on Windows, macOS, and Linux
19+
- **CI/CD Ready:** Automated testing and linting via GitHub Actions
2120

2221
---
2322

24-
## 🛠️ Architecture
23+
## Architecture
2524

26-
CodeSleuth uses a modern, efficient architecture:
27-
28-
- **Rust Parser** (`parser/`): Fast COBOL parsing and IR generation
29-
- **Rust Summarizer** (`summarizer/`): High-performance Markdown report generation
30-
- **Go CLI** (`cmd/`): User-friendly command-line interface
31-
- **Cross-platform:** Works on Windows, macOS, and Linux
25+
- **Rust Parser** (`parser/`): Parses COBOL source files and outputs an intermediate representation (IR) as JSON
26+
- **Rust Summarizer** (`summarizer/`): Consumes IR and generates Markdown reports
27+
- **Go CLI** (`cmd/`): Orchestrates parsing and summarization, providing a user-facing CLI
3228

3329
---
3430

35-
## 📦 Installation
31+
## Installation
3632

3733
### Prerequisites
3834

@@ -57,7 +53,7 @@ cd cmd && go build -o codesleuth && cd ..
5753

5854
---
5955

60-
## 🚀 Quick Start
56+
## Usage
6157

6258
```bash
6359
# Analyze a COBOL file or directory
@@ -69,25 +65,25 @@ cd cmd && go build -o codesleuth && cd ..
6965

7066
### Example Output
7167

72-
CodeSleuth generates comprehensive Markdown reports including:
68+
The tool generates Markdown reports with:
7369

7470
- **Program Information:** Name, author, date, comments
7571
- **Data Division:** Working storage and file section analysis
7672
- **Procedure Division:** Paragraph structure and statement analysis
7773
- **Call Graph:** Visual representation of program flow
78-
- **Control Flow:** Detailed execution path analysis
74+
- **Control Flow:** Execution path analysis
7975
- **Variable Usage:** Read/write analysis for all variables
8076
- **Dead Code Detection:** Unused paragraphs and variables
8177

8278
---
8379

84-
## 📋 Usage Examples
80+
## CLI Examples
8581

8682
```bash
8783
# Analyze a single file
8884
./cmd/codesleuth analyze program.cbl
8985

90-
# Analyze entire directory with verbose output
86+
# Analyze a directory with verbose output
9187
./cmd/codesleuth analyze --verbose /path/to/cobol/projects/
9288

9389
# Generate report to file
@@ -99,36 +95,31 @@ CodeSleuth generates comprehensive Markdown reports including:
9995

10096
---
10197

102-
## 🔧 Configuration
98+
## Configuration
10399

104-
CodeSleuth is designed to work out-of-the-box with minimal configuration. The tool automatically detects COBOL files (`.cob`, `.cbl`, `.cobol`) and generates appropriate analysis reports.
100+
CodeSleuth works out-of-the-box. It automatically detects COBOL files (`.cob`, `.cbl`, `.cobol`) and generates analysis reports. No additional configuration is required for standard use cases.
105101

106102
---
107103

108-
## 🤝 Contributing
109-
110-
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on:
104+
## Contributing
111105

112-
- Code style and standards
113-
- Testing requirements
114-
- Pull request process
115-
- Issue reporting
106+
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on code style, testing, pull requests, and issue reporting.
116107

117108
---
118109

119-
## 🛡️ Security
110+
## Security
120111

121-
Found a security vulnerability? Please review our [Security Policy](SECURITY.md) for responsible disclosure guidelines.
112+
If you discover a security vulnerability, please see [SECURITY.md](SECURITY.md) for responsible disclosure guidelines.
122113

123114
---
124115

125-
## 📄 License
116+
## License
126117

127-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
118+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
128119

129120
---
130121

131-
## 🔗 Links
122+
## Links
132123

133124
- [GitHub Repository](https://github.com/Cod-e-Codes/codesleuth)
134125
- [Rust Programming Language](https://www.rust-lang.org/)
@@ -137,15 +128,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
137128

138129
---
139130

140-
## 📈 Performance
141-
142-
CodeSleuth's Rust-based architecture provides significant performance improvements:
143-
144-
- **10-50x faster** than Python-based alternatives
145-
- **Lower memory usage** for large codebases
146-
- **Faster startup times** with compiled binaries
147-
- **Better concurrency** for parallel processing
148-
149-
---
150-
151-
*Built with ❤️ for the enterprise development community.*
131+
*Built for maintainers and developers working with legacy COBOL systems.*

0 commit comments

Comments
 (0)