A guide to Bedstead's source code
=================================

The source code for the Bedstead fonts lives in a Git repository
alongside some related files.  The files that are needed to actually
build the fonts are included in Bedstead releases, while the other
files are only in Git.  This document describes them.

Unless othewise mentioned, files listed here were written by Ben
Harris and are released under CC0 1.0 Universal.

Files included in releases
--------------------------

bedstead.c - The C source code that contains all of the source bitmaps
and generates the SFD files that FontForge will process into the
actual fonts.  It also generates the PostScript file for the glyph
complement.  Authorship and copyright information is at the head of
the file.

Makefile - Mechanisms for building the distributed font and the Web
site from other files.  Important targets are:

  all: builds the fonts for a release
  all-web: builds the Web site as well
  dist: builds a release and packs it into a Zip file

CONTRIBUTING - Text document describing how to contribute to Bedstead
and what one can expect from the experience.

COPYING - A copy of CC0 1.0 Universal, the legal tool under which most
of Bedstead is released.  This file is written by Creative Commons and
is itself made available under the CC0 Public Domain Dedication.  See
<https://creativecommons.org/policies/#licensing%20statement>.

HACKING - This file, a guide to the other files.

NEWS - A record of the user-visible changes to the Bedstead fonts in
each release.

df.ps - A PostScript program that builds images that can act as tilesets
for the game Dwarf Fortress.

rom.ps - A PostScript program that reconstructs the character ROMs for
SAA5050-series chips from Bedstead.  These ROM images might be usable
with the MAME emulations of those chips.

Fontmap - A Ghostscript font mapping file.  This allows Ghostscript to
find the Bedstead fonts if the build directory is on its search path.

Web site files
--------------

index.xhtml - The main page of the Bedstead Web site.

bedstead.css - The style sheet for the Bedstead Web page.

bedstead-faces.css - A style sheet that makes the Bedstead fonts
available to a Web page, but doesn't define any styles.

extended.ps, icon.ps. sample.ps - PostScript programs to generate
images for the Bedstead Web site.

titlebg.jpg - The background image for the title of the Web page.
Cropped, scaled, level-shifted, and compressed from a photo of a green
CRT connected to a BBC Microcomputer.  The original photo is at
<https://bjh21.me.uk/photos/k-m/dcim/100pentx/imgp8893.xhtml>.

.htaccess - Configuration for the Apache HTTP Server to make the Web
site work properly.

webstead.xhtml - An interactive editor written in JavaScript, which
wraps around the main "bedstead" program compiled to WebAssembly.  Not
part of the live Web site for legal reasons.

Other files in the Git repository
---------------------------------

.mailmap - A file used by Git to convert email addresses found in
Bedstead's history to their correct forms.

NOTES - Disorganised jottings about Bedstead and related matters.

compatcheck - A script to compare two versions of Bedstead OTF files
and report backward incompatibilities.

editor - An interactive editor for Bedstead character shapes.
Written by Simon Tatham and released under CC0.

panose-o.ggb - A GeoGebra file used to work out the PANOSE "Speed" and
"OutCurv" variables.  Physically takes the form of a Zip file
containing XML.

strokefont.py - An experimental script for stroking single-line
Bedstead fonts.
