From 1206b3ceed3c8ec0a66d4da123a6595c13afe9c5 Mon Sep 17 00:00:00 2001 From: Raphael MANSUY Date: Sun, 24 Mar 2024 09:55:01 +0100 Subject: [PATCH] update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 347a679..35cdbb8 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ With Code2Prompt, you can easily create a well-structured and informative docume - Respects .gitignore files to exclude unwanted files and directories - Generates a table of contents with links to each file section - Provides file metadata such as extension, size, creation time, and modification time +- Optionally strips comments from code files to focus on the core code - Includes the actual code content of each file in fenced code blocks - Handles binary files and files with encoding issues gracefully @@ -102,6 +103,7 @@ code2prompt --path /path/to/your/codebase --output output.md - `--output` (optional): Name of the output Markdown file. If not provided, the output will be displayed in the console. - `--gitignore` (optional): Path to a custom .gitignore file. If not provided, the tool will look for a .gitignore file in the specified directory. - `--filter` (optional): Filter pattern to include specific files (e.g., "*.py" to include only Python files). +- `--suppress-comments` (optional): Strip comments from the code files. If not provided, comments will be included. ### Examples @@ -120,6 +122,11 @@ code2prompt --path /path/to/your/codebase --output output.md code2prompt --path /path/to/your/project --output project.md --gitignore /path/to/custom/.gitignore ``` +4. Generate a Markdown file with comments stripped from code files: + ``` + code2prompt --path /path/to/your/project --output project.md --suppress-comments + ``` + ## Build To build a distributable package of Code2Prompt using Poetry, follow these steps: