Skip to content

Commit

Permalink
Draw attention to codebasin.py rename in README
Browse files Browse the repository at this point in the history
Signed-off-by: John Pennycook <[email protected]>
  • Loading branch information
Pennycook committed Feb 26, 2024
1 parent ccbf23c commit 2de6bc9
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ The `codebasin` script analyzes a code base described in a YAML configuration fi

To see a complete list of `codebasin` options, run `codebasin -h`.

> [!IMPORTANT]
> In previous releases of Code Base Investigator, the main script was called `codebasin.py`. The old naming was a bug that needed to be fixed, and we made the difficult decision to rename the script ahead of the next major release.
### Summary Report
The summary report (`-R summary`) gives a high-level summary of a code base, as shown below:
```
Expand Down

0 comments on commit 2de6bc9

Please sign in to comment.