mirror of
https://github.com/kirill-markin/repo-to-text.git
synced 2025-12-06 03:22:23 -08:00
readme cleanup
This commit is contained in:
parent
1817078e46
commit
a9d54aa0ca
1 changed files with 21 additions and 7 deletions
28
README.md
28
README.md
|
|
@ -1,6 +1,6 @@
|
||||||
# Repository to Text Conversion: repo-to-text command
|
# Repository to Text Conversion: repo-to-text command
|
||||||
|
|
||||||
`repo-to-text` is an open-source project that converts the structure and contents of a directory (repository) into a single text file. By executing a simple command in the terminal, this tool generates a text representation of the directory, including the output of the `tree` command and the contents of each file, formatted for easy reading and sharing. This can be very useful for development and debugging with LLM.
|
`repo-to-text` converts a directory's structure and contents into a single text file. Run it from the terminal to generate a formatted text representation that includes the directory tree and file contents. This makes it easy to share code with LLMs for development and debugging.
|
||||||
|
|
||||||
## Example of Repository to Text Conversion
|
## Example of Repository to Text Conversion
|
||||||
|
|
||||||
|
|
@ -8,15 +8,29 @@
|
||||||
|
|
||||||
The generated text file will include the directory structure and contents of each file. For a full example, see the [example output for this repository](https://github.com/kirill-markin/repo-to-text/blob/main/examples/example_repo-to-text_2024-06-09-08-06-31-UTC.txt).
|
The generated text file will include the directory structure and contents of each file. For a full example, see the [example output for this repository](https://github.com/kirill-markin/repo-to-text/blob/main/examples/example_repo-to-text_2024-06-09-08-06-31-UTC.txt).
|
||||||
|
|
||||||
The same text will appear in your clipboard. You can paste it into a dialog with the LLM and start communicating.
|
## Quick Start
|
||||||
|
|
||||||
|
Run the following command in the terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install repo-to-text
|
||||||
|
```
|
||||||
|
|
||||||
|
then open your repository and run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
repo-to-text
|
||||||
|
```
|
||||||
|
|
||||||
|
Resulting file will be saved in the current directory.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Generates a text representation of a directory's structure.
|
- Converts directory structure to text
|
||||||
- Includes the output of the `tree` command.
|
- Shows file tree
|
||||||
- Saves the contents of each file, encapsulated in markdown code blocks.
|
- Includes file contents
|
||||||
- Copies the generated text representation to the clipboard for easy sharing.
|
- Copies output to clipboard
|
||||||
- Easy to install and use via `pip`.
|
- Simple pip installation
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue