add sprites docs (#245)

protomaps · May 9, 2024 · ab20125 · ab20125
1 parent 3d001da
commit ab20125
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/sprites/README.md b/sprites/README.md
@@ -0,0 +1,13 @@
+# Sprites
+
+You will need a Rust compiler.
+
+`cargo build --release` will create the `spritegen` binary in `target/release`
+
+To generate spritesheets for the light theme:
+
+`./target/release/spritegen refill.svg themes/light.json dist/light`
+
+Creates `dist/light.json`, `dist/light.png`, `dist/[email protected]`, `dist/[email protected]`
+
+In the basemaps viewer (run `npm run dev` in `/app`), check the "local sprites" box to load sprites from `/sprites/dist`