Update README.md with correct command syntax - Fix command examples to use the correct syntax: uv run python src/custom_bingo/main.py - Update development section with correct command format

This commit is contained in:
2025-12-07 15:14:37 -05:00
parent c119eb513e
commit a383a7c461
+5 -5
View File
@@ -36,7 +36,7 @@ CustomBingo is a Python application that reads a spreadsheet with 5 columns (B,
The application provides a command-line interface for generating BINGO cards:
```bash
python -m src.custom_bingo --input-file <input_file> --output-file <output_file> [OPTIONS]
uv run python src/custom_bingo/main.py --input-file <input_file> --output-file <output_file> [OPTIONS]
```
### Options
@@ -51,13 +51,13 @@ python -m src.custom_bingo --input-file <input_file> --output-file <output_file>
```bash
# Generate a single BINGO card
python -m src.custom_bingo -i data/ChristmasSongsBingo.csv -o output.pdf
uv run python src/custom_bingo/main.py -i data/ChristmasSongsBingo.csv -o output.pdf
# Generate multiple BINGO cards
python -m src.custom_bingo -i data/ChristmasSongsBingo.csv -o output.pdf -n 5
uv run python src/custom_bingo/main.py -i data/ChristmasSongsBingo.csv -o output.pdf -n 5
# Generate a BINGO card with custom title and sub-headers
python -m src.custom_bingo -i data/ChristmasSongsBingo.csv -o output.pdf -t "Holiday Music Bingo" -s "Traditional,Upbeat,Holy,Classic,Festive"
uv run python src/custom_bingo/main.py -i data/ChristmasSongsBingo.csv -o output.pdf -t "Holiday Music Bingo" -s "Traditional,Upbeat,Holy,Classic,Festive"
```
## Input Format
@@ -104,7 +104,7 @@ CustomBingo/
3. Run with a custom data file:
```bash
uv run src/custom_bingo/main.py -i path/to/your/data.csv -o output.pdf -n 3
uv run python src/custom_bingo/main.py -i path/to/your/data.csv -o output.pdf -n 3
```
## Dependencies