Skip to content

Commit

Permalink
Updated README with pipx instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
btfranklin committed Jun 28, 2024
1 parent f88efc2 commit 1c106fc
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Coderoller

`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.
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.

## Features

Expand All @@ -11,27 +11,22 @@

## Installation

Coderoller requires Python 3.12 or later and PDM for package management.
Coderoller requires Python 3.10 or later.

1. Clone the repository:
### Using pipx

```bash
git clone https://github.com/yourusername/coderoller.git
cd coderoller
```
You can install Coderoller globally using pipx:

2. Install dependencies using PDM:

```bash
pdm install
```
```bash
pipx install coderoller
```

## Usage

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

```bash
pdm run coderoller-flatten-repo /path/to/root/folder
coderoller-flatten-repo /path/to/root/folder
```

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

0 comments on commit 1c106fc

Please sign in to comment.