From 06792cf28986c6d792946cf1be492a399e12f585 Mon Sep 17 00:00:00 2001 From: Nikola Hristov Date: Tue, 30 Jul 2024 15:02:38 +0300 Subject: [PATCH] --- README.md | 68 ++++++++++++++++++++----------------------------------- 1 file changed, 24 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 43687dc..601eca0 100644 --- a/README.md +++ b/README.md @@ -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] @@ -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: