Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
raphaelmansuy committed Mar 24, 2024
1 parent 206bcb3 commit 1206b3c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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:
Expand Down

0 comments on commit 1206b3c

Please sign in to comment.