Refactor for demonstration

.gitignore

@@ -1,4 +1,17 @@
-*.svg
-*.png
-*.pxd
-__pycache__
+# Packaging and distribution
+*.egg
+*.egg-info*
+*.whl
+dist
+build
+
+# Compiled files
+__pycache__/
+*.pyc
+*.out
+
+# Development tooling
+.hypothesis/
+.ipynb_checkpoints/
+.pytest_cache/
+.ruff_cache/

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+ci:
+  autoupdate_schedule: quarterly
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 'v4.4.0'
+    hooks:
+      - id: end-of-file-fixer
+        exclude: tests/sample_data
+      - id: trailing-whitespace
+        exclude: tests/sample_data
+      - id: check-builtin-literals
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-yaml
+      - id: debug-statements
+      - id: requirements-txt-fixer
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        types_or: [ python, pyi, jupyter ]
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [ python, pyi, jupyter ]

README.md

@@ -4,6 +4,19 @@ This is a single-file Python library for generating 3D wireframes in SVG format.
 For a description of how the library was initially designed and implemented, check out
 [this blog post](https://prideout.net/blog/svg_wireframes/#using-the-api).
 
+## Installation
+
+```bash
+
+    # Clone the repository
+    git clone https://github.com/janbridley/svg3d.git
+    cd svg3d
+
+    # Install to your python environment!
+    python -m pip install .
+
+```
+
 ## Usage example (ConvexPolyhedron)
 ```python
 from coxeter.families import ArchimedeanFamily
@@ -50,17 +63,48 @@ truncated_cube = ArchimedeanFamily.get_shape("Truncated Cube")
 generate_svg(filename="truncated_cube.svg", poly=truncated_cube)
 ```
 
+Running the code above generates the following image:
+
+![Output for the first example.](doc/svgs/truncated_cube.svg)
+
 And that's all it takes! For an even simpler startup, use one of the built in viewports.
 
 For example:
 
 ```python
 import svg3d
 
-scene = [svg3d.Mesh.from_poly(poly, style=style)]
 
+style = dict(
+    fill="#00B2A6",
+    fill_opacity="0.85",
+    stroke="black",
+    stroke_linejoin="round",
+    stroke_width="0.005",
+)
+
+scene = [
+    svg3d.Mesh.from_poly(
+        poly=ArchimedeanFamily.get_shape("Truncated Cube"),
+        style=style
+    )
+]
+
+# Convenience views: isometric, dimetric, and trimetric
 iso = svg3d.View.isometric(scene, fov=1.0)
 dim = svg3d.View.dimetric(scene, fov=1.0)
 tri = svg3d.View.trimetric(scene, fov=1.0)
 
+
+for view, view_type in zip([iso, dim, tri], ["iso", "dim", "tri"]):
+
+    svg3d.Engine([view]).render(f"{view_type}.svg")
+
+
+
 ```
+
+| Isometric | Dimetric | Trimetric |
+|-----------|----------|-----------|
+| ![Isometric Image](doc/svgs/iso.svg) | ![Dimetric Image](doc/svgs/dim.svg) | ![Trimetric Image](doc/svgs/tri.svg) |
+

example.py

@@ -30,13 +30,13 @@ def generate_svg(filename, poly):
     svg3d.Engine([view]).render(filename)
 
 
-style = dict(
-    fill="#00B2A6",
-    fill_opacity="0.85",
-    stroke="black",
-    stroke_linejoin="round",
-    stroke_width="0.005",
-)
+style = {
+    "fill": "#00B2A6",
+    "fill_opacity": "0.85",
+    "stroke": "black",
+    "stroke_linejoin": "round",
+    "stroke_width": "0.005",
+}
 
 truncated_cube = ArchimedeanFamily.get_shape("Truncated Cube")
 generate_svg(filename="truncated_cube.svg", poly=truncated_cube)