Skip to content

Commit bbdc55a

Browse files
committed
docs: clean up usage section to remove redundant commands
1 parent 59887d3 commit bbdc55a

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,22 +56,19 @@ cd cmd && go build -o codesleuth && cd ..
5656
## Usage
5757

5858
```bash
59-
# Analyze a COBOL file or directory
60-
./cmd/codesleuth analyze --verbose path/to/your/cobol/files
59+
# Analyze a COBOL file or directory (basic usage)
60+
./cmd/codesleuth analyze path/to/your/cobol/files
6161

62-
# Generate a report file
63-
./cmd/codesleuth analyze test-cobol/ > analysis_report.md
62+
# Enable verbose output
63+
./cmd/codesleuth analyze --verbose path/to/your/cobol/files
6464

6565
# Analyze a single file
6666
./cmd/codesleuth analyze program.cbl
6767

68-
# Analyze a directory with verbose output
69-
./cmd/codesleuth analyze --verbose /path/to/cobol/projects/
70-
71-
# Generate report to file
72-
./cmd/codesleuth analyze legacy-system/ > system_analysis.md
68+
# Output analysis to a Markdown file
69+
./cmd/codesleuth analyze path/to/your/cobol/files > analysis_report.md
7370

74-
# Analyze with debug information
71+
# Analyze with debug information (verbose + debug)
7572
./cmd/codesleuth analyze --verbose --debug complex-program.cbl
7673
```
7774

0 commit comments

Comments
 (0)