Skip to content

Commit

Permalink
No commit message
Browse files Browse the repository at this point in the history
  • Loading branch information
NikolaRHristov committed Jul 30, 2024
1 parent f4c3dbd commit 06792cf
Showing 1 changed file with 24 additions and 44 deletions.
68 changes: 24 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,30 @@ repository.

The `Summary` tool can be used with various options:

- `--Root` or `-R`: Set the root directory to analyze (default is current
directory)
- `--Parallel` or `-P`: Run processing in parallel (default is sequential)
- `--Exclude` or `-E`: Exclude certain files or directories (default is
"node_modules")
- `--Pattern`: Specify a custom pattern for matching (default is ".git")
- `--Omit` or `-O`: Specify regex patterns to omit files from processing
(default is "Documentation")
- `--Separator`: Define a custom separator (default is system path separator)
#### --Root or -R:

Set the current working directory to a different folder (default is `.`):

#### --Parallel or -P:

Run processing in parallel (default is `sequential`):

#### --Exclude:

Exclude certain files or directories (defailt is `node_modules`).

#### --Pattern:

Specify a custom pattern for matching (defailt is `.git`).

#### --Separator:

Define a custom separator (default is system path separator).

#### --Omit or -O:

Specify regex patterns to omit files from processing (default is
"Documentation").

For [Pieces OS] integration, refer to the [Pieces OS] documentation for specific
flags and configuration options. [Pieces OS]
Expand Down Expand Up @@ -89,41 +104,6 @@ Omit specific file patterns:
Summary -O "\.md$" -O "\.txt$"
```

## Options

#### --Root or -R:

Set the current working directory to a different folder (default is `.`):

```sh
Summary -R D:\Developer
```

#### --Parallel or -P:

Summary commands in `parallel` (default is `sequential`):

```sh
Summary -P -R D:\Developer
```

#### --Exclude:

Exclude certain files or directories (defailt is
`node_modules target dist vendor`)

#### --Pattern:

Specify a custom pattern for matching (defailt is `.git`)

#### --Separator:

Define a custom separator.

#### --Omit:

List of regex to to match on files omitted from processing.

## Dependencies

`Summary` relies on several Rust crates to provide its functionality:
Expand Down

0 comments on commit 06792cf

Please sign in to comment.