docs: update installation instructions and usage examples in README
This commit is contained in:
45
README.md
45
README.md
@@ -1,5 +1,8 @@
|
||||
# Codebase to Prompt
|
||||
|
||||
[](https://github.com/GKaszewski/codebase-to-prompt/actions/workflows/ci.yml)
|
||||
[](https://github.com/GKaszewski/codebase-to-prompt/actions/workflows/release.yml)
|
||||
|
||||
`codebase-to-prompt` is a Rust-based CLI tool designed to bundle files from a directory into a single output file. It supports filtering files by extensions, respecting `.gitignore` rules, and formatting the output in Markdown, plain text, or console-friendly formats.
|
||||
|
||||
## Features
|
||||
@@ -14,6 +17,30 @@
|
||||
|
||||
## Installation
|
||||
|
||||
There are multiple ways to install `codebase-to-prompt`.
|
||||
|
||||
### Option 1: Using `cargo install` (Recommended for Rust developers)
|
||||
|
||||
If you have the Rust toolchain installed, you can easily install the latest version from [crates.io](https://crates.io/):
|
||||
|
||||
```bash
|
||||
cargo install codebase-to-prompt
|
||||
```
|
||||
|
||||
### Option 2: Using the Install Script (for Linux & macOS)
|
||||
|
||||
You can download and run the installation script, which will install the latest release binary for your system:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/GKaszewski/codebase-to-prompt/main/install.sh | sh
|
||||
```
|
||||
|
||||
### Option 3: From GitHub Releases
|
||||
|
||||
You can download the pre-compiled binary for your operating system directly from the [Releases page](https://github.com/GKaszewski/codebase-to-prompt/releases).
|
||||
|
||||
### Option 4: Building from Source
|
||||
|
||||
1. Ensure you have [Rust](https://www.rust-lang.org/) installed.
|
||||
2. Clone this repository:
|
||||
```bash
|
||||
@@ -51,7 +78,7 @@ codebase-to-prompt [OPTIONS] [DIRECTORY]
|
||||
1. Bundle all `.rs` files in the current directory into `output.md` in Markdown format:
|
||||
|
||||
```bash
|
||||
codebase-to-prompt -o output.md -i rs --format markdown
|
||||
codebase-to-prompt -o output.md -i rs
|
||||
```
|
||||
|
||||
2. Bundle all files except `.log` files, appending the current date and Git hash to the output file name:
|
||||
@@ -61,6 +88,7 @@ codebase-to-prompt [OPTIONS] [DIRECTORY]
|
||||
```
|
||||
|
||||
3. Output all files to the console, including line numbers:
|
||||
|
||||
```bash
|
||||
codebase-to-prompt -l
|
||||
```
|
||||
@@ -87,19 +115,6 @@ To run tests:
|
||||
cargo test
|
||||
```
|
||||
|
||||
### Code Structure
|
||||
|
||||
- `src/lib.rs`: Core logic for file processing and bundling.
|
||||
- `src/main.rs`: CLI entry point.
|
||||
|
||||
### Adding Dependencies
|
||||
|
||||
To add a new dependency, update `Cargo.toml` and run:
|
||||
|
||||
```bash
|
||||
cargo build
|
||||
```
|
||||
|
||||
### Linting and Formatting
|
||||
|
||||
To lint the code:
|
||||
@@ -120,4 +135,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Feel free to open issues or submit pull requests.
|
||||
Contributions are welcome\! Feel free to open issues or submit pull requests.
|
||||
|
Reference in New Issue
Block a user