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
+24-3Lines changed: 24 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,15 @@
1
1
# CodeSleuth
2
2
3
-
**CodeSleuth** is a modern, multi-language code intelligence CLI tool focused on COBOL analysis. It combines a fast Rust parser, a Go CLI, and a Python Markdown summarizer to provide actionable, human-friendly reports for legacy codebases.
**CodeSleuth** is a modern, multi-language code intelligence CLI tool focused on COBOL analysis. It combines a fast Rust parser, a Go CLI, and a Python Markdown summarizer to provide actionable, human-friendly reports for legacy codebases.
6
13
7
14
---
8
15
@@ -12,6 +19,8 @@
12
19
-**Dead Code Detection:** Lists unused paragraphs and variables.
13
20
-**Extensible Pipeline:** Modular Rust, Go, and Python components.
14
21
-**Modern CLI:** Easy to use, with verbose/debug options.
22
+
-**Security Policy:** See [SECURITY.md](SECURITY.md)
23
+
-**Continuous Integration:** Automated tests and linting via GitHub Actions.
15
24
16
25
---
17
26
@@ -31,7 +40,7 @@ cd codesleuth
31
40
32
41
Install Python dependencies:
33
42
```sh
34
-
pip install -r requirements.txt# (if you add one)
43
+
pip install -r requirements.txt
35
44
```
36
45
37
46
### 3. Build the Rust Parser
@@ -68,6 +77,18 @@ cd ..
68
77
69
78
---
70
79
80
+
## Security
81
+
82
+
If you discover a security vulnerability, please see [SECURITY.md](SECURITY.md) for responsible disclosure guidelines.
83
+
84
+
---
85
+
86
+
## Continuous Integration
87
+
88
+
This project uses GitHub Actions for automated testing and linting. See `.github/workflows/ci.yml` for details.
89
+
90
+
---
91
+
71
92
## Contributing
72
93
Pull requests, issues, and suggestions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
0 commit comments