File tree Expand file tree Collapse file tree 1 file changed +14
-8
lines changed Expand file tree Collapse file tree 1 file changed +14
-8
lines changed Original file line number Diff line number Diff 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
5459The 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
8590Requirements:
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
95100mypy llms.py
96101
97- # Run linting
102+ # Run linting and formatting
98103ruff check .
104+ ruff format .
99105```
100106
101107## License
You can’t perform that action at this time.
0 commit comments