README.md

Examples

This folder contains ready-to-run example scripts for github-grid-editor.

Note: these examples were inspired by contribution-graph art and patterns shared on the internet, then adapted into runnable scripts for this project.

How to use them

Preview an example without writing commits:

./examples/<name>.sh

Generate commits for an example:

REPO_PATH=/tmp/<name>-graph GIT_EMAIL=you@example.com ./examples/<name>.sh --generate

Most scripts support both preview and generation. waves.sh is currently preview-oriented and always shows the dashboard.

cat.sh

Cat pixel art traced cell-by-cell from a GitHub graph screenshot.

./examples/cat.sh
REPO_PATH=/tmp/cat-graph GIT_EMAIL=you@example.com ./examples/cat.sh --generate

ecg.sh

ECG / heartbeat waveform traced cell-by-cell from a contribution graph screenshot.

./examples/ecg.sh
REPO_PATH=/tmp/ecg-graph GIT_EMAIL=you@example.com ./examples/ecg.sh --generate

equalizer.sh

Sound equalizer with irregular bar heights across the grid.

./examples/equalizer.sh
REPO_PATH=/tmp/equalizer-graph GIT_EMAIL=you@example.com ./examples/equalizer.sh --generate

mascots.sh

Pixel art mashup with Octocat, a Mario mushroom, and a small cat.

./examples/mascots.sh
REPO_PATH=/tmp/mascots-graph GIT_EMAIL=you@example.com ./examples/mascots.sh --generate

mondrian.sh

Mondrian-style contribution graph composition traced from a screenshot.

./examples/mondrian.sh
REPO_PATH=/tmp/mondrian-graph GIT_EMAIL=you@example.com ./examples/mondrian.sh --generate

nature-landscape-background.sh

Nature landscape with mountain shapes and a filled ground/background.

./examples/nature-landscape-background.sh
REPO_PATH=/tmp/nature-graph GIT_EMAIL=you@example.com ./examples/nature-landscape-background.sh --generate

pacman.sh

Pac-Man pixel art traced cell-by-cell from a contribution graph screenshot.

./examples/pacman.sh
REPO_PATH=/tmp/pacman-graph GIT_EMAIL=you@example.com ./examples/pacman.sh --generate

pixel-art.sh

Reference pixel-art composition traced cell-by-cell from a contribution graph screenshot.

./examples/pixel-art.sh
REPO_PATH=/tmp/pixel-art-graph GIT_EMAIL=you@example.com ./examples/pixel-art.sh --generate

ships.sh

Two ships pixel art traced cell-by-cell from a contribution graph screenshot.

./examples/ships.sh
REPO_PATH=/tmp/ships-graph GIT_EMAIL=you@example.com ./examples/ships.sh --generate

space-invader.sh

Three Space Invaders distributed across the contribution graph.

./examples/space-invader.sh
REPO_PATH=/tmp/space-invader-graph GIT_EMAIL=you@example.com ./examples/space-invader.sh --generate

waves.sh

Ocean wave pattern with repeated sinusoidal crests across the year.

./examples/waves.sh