Skip to content

Commit

Permalink
Updated README with info about straight-from-git flattening
Browse files Browse the repository at this point in the history
  • Loading branch information
btfranklin committed Jun 29, 2024
1 parent d535975 commit 4724ca5
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Coderoller is a Python utility that flattens a source code repository into a sin
- **Supports multiple file types** including `.py`, `.js`, `.jsx`, `.ts`, `.tsx`, `.swift`, `.go`, `.java`, `.c`, `.cpp`, `.h`, `.hpp`, `.cs`, `.lua`, `.rb`, `.php`, `.pl`, `.html`, `.css`, `.json`, `.toml`, `.md`, `.yaml`, `.yml`, `.conf`, `.ini`, and `.sh`.
- **Automatically includes README** files if present, placing it at the start of the flattened file.
- **Excludes hidden files and directories** (those starting with a dot).
- **Supports flattening directly from Git URLs** even if the repository is not cloned locally.

## Installation

Expand All @@ -26,10 +27,16 @@ pipx install coderoller
To flatten a source repository, use the `coderoller-flatten-repo` script.

```bash
coderoller-flatten-repo /path/to/root/folder
coderoller-flatten-repo /path/to/reponame
```

This command will create a markdown file named `reponame.flat.md` in the current working directory, containing the flattened contents of the repository.
To flatten a source repository directly from a Git URL, use the coderoller-flatten-repo script with the repository URL:

```bash
coderoller-flatten-repo https://github.com/username/reponame.git
```

Both commands will create a markdown file named `reponame.flat.md` in the current working directory, containing the flattened contents of the repository.

## License

Expand Down

0 comments on commit 4724ca5

Please sign in to comment.