Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
saltcandy123 committed Jan 20, 2024
1 parent 163dcc8 commit a540320
Showing 1 changed file with 30 additions and 12 deletions.
42 changes: 30 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# saltcandy123font

@saltcandy123 による手書きフォントです。
saltcandy123font は @saltcandy123 による手書きフォントです。

This is a font based on the handwriting of @saltcandy123.
saltcandy123font is a font based on the handwriting of @saltcandy123.

![A font image of saltcandy123font.](fontimage.png)
![A font image of saltcandy123font.](./fontimage.png)

Visit [demo page](https://saltcandy123.github.io/saltcandy123font/) to try the font with your texts.
Visit [the demo page](https://saltcandy123.github.io/saltcandy123font/) to try the font with your texts.

## Installation

- Get fhe font files from [the release page](https://github.com/saltcandy123/saltcandy123font/releases/latest).
- If you use npm, `npm install @saltcandy123/saltcandy123font` ([npm package](https://www.npmjs.com/package/@saltcandy123/saltcandy123font))
Download `saltcandy123font.zip` from
[the release page on GitHub](https://github.com/saltcandy123/saltcandy123font/releases/latest), uncompress the zip file and install the font file to your system.

Alternatively, if you use the font in a Node.js project, run `npm install @saltcandy123/saltcandy123font` ([npm package](https://www.npmjs.com/package/@saltcandy123/saltcandy123font)).

## Supported characters

Expand All @@ -24,18 +26,22 @@ Visit [demo page](https://saltcandy123.github.io/saltcandy123font/) to try the f
- (U+FF00 - U+FFEF) Halfwidth and Fullwidth Forms
- Excluding halfwidth Hangul variants and halfwidth symbol variants (U+FFA0 - U+FFDC, U+FFE8 - U+FFEE)

## Source code
## Development

### Source code

- **`glyphs/xxxx/uXXXX.svg`** defines the shape of each character. For example, [`u0073.svg`](glyphs/basic-latin/u0073.svg) is the image of "s" (U+0073). A character may have another image (`uXXXX-vert.svg`) for vertical writing ("vert" feature).
- **`glyphs/xxxx/uXXXX.svg`** defines the shape of each character. For example, [`u0073.svg`](glyphs/basic-latin/u0073.svg) is the image of "s" (U+0073). A character may have another image (`uXXXX-vert.svg`) for vertical writing ("vert" feature). The SVG files are in the `glyphs` directory or subdirectories named after Unicode blocks.
- **[`scripts/fontbuild.py`](scripts/fontbuild.py)** builds a font from the glyph SVG files.
- **[`scripts/glyphclean.py`](scripts/glyphclean.py)** cleans SVG files by removing extra data from SVG.
- **[`scripts/distbuild.py`](scripts/distbuild.py)** builds distribution files under `dist` directory.
- **[`scripts/fontimagegen.sh`](scripts/fontimagegen.sh)** produces a font thumbnail image.
- **[`scripts/distbuild.py`](scripts/distbuild.py)** builds distribution packages under the `dist` directory.
- **[`scripts/fontimagegen.sh`](scripts/fontimagegen.sh)** produces a font thumbnail image for README.
- **`.github/workflows/*.yml`** defines workflows for GitHub Actions.
- **[`.github/workflows/release.yml`](.github/workflows/release.yml)** creates a release with a zip file when a git tag is pushed, and publishes the npm package.
- **[`.github/workflows/verification.yml`](.github/workflows/verification.yml)** builds a font and tests it using a font quality assurance tool [Font Bakery](https://github.com/fonttools/fontbakery).
- **[`.github/workflows/font-image.yml`](.github/workflows/font-image.yml)** updates [`fontimage.png`](fontimage.png) on a git branch using a built font.

Note that the scripts require Python 3.11 and [FontForge](https://fontforge.org/) 2023-01-01.

Refer to `gh-pages-src` branch for the source code of the demo page.

### How to add a glyph

```bash
Expand All @@ -61,3 +67,15 @@ python scripts/glyphclean.py glyphs/draft
## Build a font file
python scripts/fontbuild.py -o font.ttf
```

The glyphs for this font were drawn with Inkscape using "Calligraphy Tool" with the settings as follows:

- Marker
- Width: 75px
- Thinning: 0
- Mass: 2
- Angle: 90
- Fixation: 0
- Caps: 1.00
- Tremor: 0
- Wiggle: 0

0 comments on commit a540320

Please sign in to comment.