docs: update installation and usage instructions to use uv and remove requirements.txt

Author: rtuszik

README.md

@@ -64,39 +64,32 @@ Explore the demo to see how KoalaKeys works and to get ideas for creating custom
 
 1. Clone the repository:
 
-   ```
-   git clone https://github.com/rtuszik/KoalaKeys
-   cd KoalaKeys
-   ```
+    ```
+    git clone https://github.com/rtuszik/KoalaKeys
+    cd KoalaKeys
+    ```
 
 2. Create and activate a virtual environment (optional):
 
-   ```
-   python -m venv .venv
-   source .venv/bin/activate  # On Windows, use `venv\Scripts\activate`
-   ```
+    ```
+    uv sync --locked
+    ```
 
-3. Install dependencies:
-
-   ```
-   pip install -r requirements.txt
-   ```
-
-4. Set up the output directory:
+3. Set up the output directory:
    Create a `.env` file in the project root with:
-   ```
-   CHEATSHEET_OUTPUT_DIR=path/to/your/output/directory
-   ```
+    ```
+    CHEATSHEET_OUTPUT_DIR=path/to/your/output/directory
+    ```
 
 ## Usage
 
 1. Create YAML files for your cheat sheets in the `cheatsheets` directory. For detailed instructions on how to format YAML files, please refer to the [YAML Cheat Sheet Specification Guide](yaml_cheatsheet_spec.md).
 
 2. Generate cheat sheets:
 
-   ```
-   python src/generate_cheatsheet.py
-   ```
+    ```
+    uv run src/generate_cheatsheet.py
+    ```
 
 3. Find the HTML cheat sheets in the specified output directory.
 

cheatsheets/example-cheatsheet.yaml

@@ -2,16 +2,16 @@ title: "KoalaKeys"
 RenderKeys: true # defaults to true
 AllowText: false # defaults to false - requires RenderKeys: false
 layout:
-  keyboard: US
-  system: Darwin
+    keyboard: US
+    system: Darwin
 shortcuts:
-  General:
-    "CMD+C":
-      description: "Copy selected item"
-    "CMD+X":
-      description: "Cut selected item"
-  File and App Management:
-    "CMD+N":
-      description: "Open new window or document"
-    "CMD+O":
-      description: "Open selected item or display dialog to choose file to open"
+    General:
+        "CMD+C":
+            description: "Copy selected item"
+        "CMD+X":
+            description: "Cut selected item"
+    File and App Management:
+        "CMD+N":
+            description: "Open new window or document"
+        "CMD+O":
+            description: "Open selected item or display dialog to choose file to open"

pyproject.toml

@@ -4,8 +4,4 @@ version = "0.6.0"
 description = "Build interactive, portable cheatsheets from YAML."
 readme = "README.md"
 requires-python = ">=3.9"
-dependencies = [
-    "jinja2>=3.1.6",
-    "python-dotenv>=1.1.1",
-    "ruamel-yaml>=0.18.14",
-]
+dependencies = ["jinja2>=3.1.6", "python-dotenv>=1.1.1", "ruamel-yaml>=0.18.14"]