Skip to content

Commit 62585b3

Browse files
committed
updates
1 parent 612761e commit 62585b3

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,17 @@ A Python tool for compressing and organizing code files into a single, LLM-frien
2929

3030
## Installation
3131

32+
This project uses [uv](https://github.com/astral-sh/uv) for dependency management.
33+
3234
```bash
33-
# Using pip
34-
pip install -r requirements.txt
35+
# Install uv if you haven't already
36+
curl -LsSf https://astral.sh/uv/install.sh | sh
37+
38+
# Install the package and its dependencies
39+
uv pip install .
3540

36-
# Using uv (recommended)
37-
uv pip install -r requirements.txt
41+
# For development
42+
uv pip install -e ".[dev]"
3843
```
3944

4045
## Usage
@@ -53,7 +58,7 @@ python llms.py
5358

5459
The generated `llms.txt` file follows this structure:
5560

56-
```
61+
``` python
5762
# Project metadata
5863
<file>path/to/file.py</file>
5964
<metadata>
@@ -83,9 +88,9 @@ def example():
8388
## Development
8489

8590
Requirements:
91+
8692
- Python 3.8+
87-
- mypy for type checking
88-
- ruff for linting
93+
- [uv](https://github.com/astral-sh/uv) for dependency management
8994

9095
```bash
9196
# Install dev dependencies
@@ -94,8 +99,9 @@ uv pip install -e ".[dev]"
9499
# Run type checking
95100
mypy llms.py
96101

97-
# Run linting
102+
# Run linting and formatting
98103
ruff check .
104+
ruff format .
99105
```
100106

101107
## License

0 commit comments

Comments
 (0)