Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noah-art3mis committed Jun 29, 2024
1 parent ad9ffca commit 0765bb0
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# Facsimile

Make your own simulacrum plates. Uses HTML/CSS/TS with [html2canvas](https://html2canvas.hertzen.com/). Part of AUTOMATON.
Make your own simulacrum plates.

Use at https://facsimile.vercel.app/
Available at https://facsimile.vercel.app/

Uses HTML/CSS/TS and [html2canvas](https://html2canvas.hertzen.com/).

Part of AUTOMATON.

## How to

1. Upload a "book" file. A "book" file is a JSON file with a specific structure that represents quotations. Use [Apothecary](https://github.com/noah-art3mis/apothecary) to get one.
1. Adjust the color parameters. Use [Mirage](https://github.com/noah-art3mis/mirage) to find a color palette.
1. Use `PageUp`/`UpArrow` and `PageDown`/`DownArrow` to check resulting images for any issues. If any arise, edit the book file directly and reupload it.
1. If everything is ok, press `Compile` and wait for the images to be processed. Depending on the amount of images, this can take a minute or two. For a quick way to check progress, see if the scrollbar is moving.
1. After compilation, press `Download`.
1. Press `Compile` and wait for the images to be processed. Depending on the amount of images, this can take a minute or two. Wait until there are no more messages appearing in the console (`ctrl + shift + k`).
1. Press `Download`.

## TODO

- add: loading feedback for compilation stage.
- add: loading feedback for compilation stage.

0 comments on commit 0765bb0

Please sign in to comment.