Skip to content

Commit

Permalink
fleshing out readme with example
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdmiller authored Jan 4, 2025
1 parent e0a35ff commit d9aeb4e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Shape Mapper is a [Processing](processing.org/) library for projection mapping.

![output](https://github.com/user-attachments/assets/af2e75f6-b4d0-4e52-bb8e-f2c5d644a5bc)

<img width="700" alt="getting-started-2" src="https://github.com/user-attachments/assets/0595fd10-d813-4704-8645-975ee4f563a4" />


## Example code

Here is a minimal example showing what the library interface looks like:
Expand All @@ -30,6 +33,8 @@ void draw() {
}
```

Find more examples [in the repository](examples/), packaged within the library, or on the [documentation site](https://alexdmiller.github.io/shape-mapper/).

## Use cases

[Projection mapping](https://en.wikipedia.org/wiki/Projection_mapping) is the process of calibrating a digital projection to align with a three dimensional surface. The Shape Mapper library is useful if you have a 3D model of the object you want to projection map. Some example workflows:
Expand Down

0 comments on commit d9aeb4e

Please sign in to comment.