From: Ben Harris <bjh21@bjh21.me.uk>
Date: Sat, 12 Oct 2024 11:45:05 +0000 (+0100)
Subject: Add a HACKING file that's a guide to the source code
X-Git-Tag: bedstead-002.009~12
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~bjharris/git?a=commitdiff_plain;h=8d58b7485c111ae1196e919711f98e2ab33c68a9;p=bedstead.git

Add a HACKING file that's a guide to the source code

Suggested by Ian Jackson.
---

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..98da049
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,86 @@
+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.
+
+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 declaration under which
+most of Bedstead is released.  This file is written by Creative
+Commons Corporation 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.
+
+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.
+
+editor.py - An interactive editor for Bedstead character shapes.
+Written by Simon Tatham.
+
+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.
diff --git a/Makefile b/Makefile
index af53a83..e0bfc1b 100644
--- a/Makefile
+++ b/Makefile
@@ -8,8 +8,8 @@ FONTBASES = bedstead bedstead-extended bedstead-semicondensed \
 SFDFILES = $(addsuffix .sfd, $(FONTBASES))
 OTFFILES = $(addsuffix .otf, $(FONTBASES))
 
-DISTFILES = bedstead.c Makefile CONTRIBUTING COPYING NEWS df.ps rom.ps \
-	Fontmap \
+DISTFILES = bedstead.c Makefile CONTRIBUTING COPYING HACKING NEWS \
+	df.ps rom.ps Fontmap \
 	$(OTFFILES) \
 	bedstead-10.bdf bedstead-20.bdf bedstead-bold-20.bdf \
 	bedstead-10-df.png bedstead-20-df.png \