The build uses a Docker container to handle build dependencies, so you'll need to have Docker installed.
The repository has submodules, so you need to clone with --recursive flag
git clone --recursive https://github.com/noppa/text-security.gitRunning
./build-container.shwill build a Docker container named "text-security-font-builder" with all the build dependencies.
This step only needs to be done once if you don't need to modify Dockerfile.
Some warnings are expected and OK, as long as the process ends with message like
"Successfully built ...".
After you have built the container, running
./build-font.shwill generate fonts for shapes in src/shapes folder.
The generated fonts and css will appear in output folder.
Some warnings are expected and OK, as long as the process ends with message like
"Font file ... generated."
The shape files live in src/shapes. They are defined using Adobe Type 1 Font Format,
which is similar to what OpenType uses.
I know it's not exactly the easiest and most familiar format to specify shapes,
but that's what's consumed by the Adobe font tools that this project uses, so we'll just have to live with it.
disc.ps and circle.ps have
some comments that might give you a good starting point to your own shapes.
Developing a shape will likely involve lots of trial and error, which is easier if you don't have to run the build command manually after every change.
Building the fonts with
./build-font.sh --watchstarts monitoring changes to the shape files and will automatically build the woff2 font for your modified shape. Modify text-security.html to include your font (if you are creating a new shape) and open it in a browser (modern browser, not IE) to see the results.