Skip to content

Commit

Permalink
Update README.md to reference new codebasin script
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 f1a10e8 commit ccbf23c
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,10 @@ CBI tracks specialization in two forms: source files that are not compiled for a
3) Record which specializations are used by each platform.

## Usage
```
usage: codebasin.py [-h] [-c FILE] [-v] [-q] [-r DIR] [-R REPORT [REPORT ...]] [-d DUMPFILE]
optional arguments:
-h, --help show this help message and exit
-c FILE, --config FILE
configuration file (default: <DIR>/config.yaml)
-v, --verbose verbosity level
-q, --quiet quiet level
-r DIR, --rootdir DIR
Set working root directory (default .)
-R REPORT [REPORT ...], --report REPORT [REPORT ...]
desired output reports (default: all)
-d DUMPFILE, --dump DUMPFILE
dump annotated parse tree to DUMPFILE
```
The `codebasin.py` script analyzes a code base described in a YAML configuration file and produces one or more output reports. Example configuration files can be found in the [examples](./examples) directory, and see the [configuration file documentation](docs/configuration.md) for a detailed description of the configuration file format.

The `codebasin` script analyzes a code base described in a YAML configuration file and produces one or more output reports. Example configuration files can be found in the [examples](./examples) directory, and see the [configuration file documentation](docs/configuration.md) for a detailed description of the configuration file format.

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

### 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 ccbf23c

Please sign in to comment.