Skip to content

Commit 1c106fc

Browse files
committed
Updated README with pipx instructions
1 parent f88efc2 commit 1c106fc

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Coderoller
22

3-
`Coderoller` is a Python utility that flattens a source code repository into a single markdown file. This tool collects all relevant source and configuration files, including Python, JavaScript, TypeScript, HTML, CSS, JSON, and more, and compiles them into a markdown document. The flattened file provides an organized overview of the repository's contents, making it easy to use in conjunction with LLMs. Simply copy the contents of the flattened file and paste it into your LLM chat context. The flattened form is also great for API-based uses of LLMs in automated workflows.
3+
Coderoller is a Python utility that flattens a source code repository into a single markdown file. This tool collects all relevant source and configuration files, including Python, JavaScript, TypeScript, HTML, CSS, JSON, and more, and compiles them into a markdown document. The flattened file provides an organized overview of the repository's contents, making it easy to use in conjunction with LLMs. Simply copy the contents of the flattened file and paste it into your LLM chat context. The flattened form is also great for API-based uses of LLMs in automated workflows.
44

55
## Features
66

@@ -11,27 +11,22 @@
1111

1212
## Installation
1313

14-
Coderoller requires Python 3.12 or later and PDM for package management.
14+
Coderoller requires Python 3.10 or later.
1515

16-
1. Clone the repository:
16+
### Using pipx
1717

18-
```bash
19-
git clone https://github.com/yourusername/coderoller.git
20-
cd coderoller
21-
```
18+
You can install Coderoller globally using pipx:
2219

23-
2. Install dependencies using PDM:
24-
25-
```bash
26-
pdm install
27-
```
20+
```bash
21+
pipx install coderoller
22+
```
2823

2924
## Usage
3025

3126
To flatten a source repository, use the `coderoller-flatten-repo` script.
3227

3328
```bash
34-
pdm run coderoller-flatten-repo /path/to/root/folder
29+
coderoller-flatten-repo /path/to/root/folder
3530
```
3631

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

0 commit comments

Comments
 (0)