UNPKG

3.54 kBMarkdownView Raw
1# @sutton-signwriting/font-ttf
2[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
3[![version](https://img.shields.io/npm/v/@sutton-signwriting/font-ttf)](https://www.npmjs.com/package/@sutton-signwriting/font-ttf)
4[![npm downloads](https://img.shields.io/npm/dm/@sutton-signwriting/font-ttf)](https://npm-stat.com/charts.html?package=@sutton-signwriting/font-ttf&from=2019-12-09)
5
6![SignWriting](./signwriting.png)
7
8@sutton-signwriting/font-ttf is a javascript package for the browser that generates SVG and PNG images for individual symbols and complete signs using TrueType Fonts. The package covers the entire set of the International SignWritnig Alphabet 2010 (ISWA 2010).
9
10This package supports both Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets, along with the style string. See [draft-slevinski-formal-signwriting](https://tools.ietf.org/id/draft-slevinski-formal-signwriting-07.html) for detailed specification.
11
12> Author: https://SteveSlevinski.me
13> Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow
14> Support: https://www.patreon.com/signwriting
15
16## Useful links
17
18- GitHub Repo: https://github.com/sutton-signwriting/font-ttf
19- Distribution: https://unpkg.com/browse/@sutton-signwriting/font-ttf/
20- Documentation: https://sutton-signwriting.github.io/font-ttf/
21- Issue Tracker: https://github.com/sutton-signwriting/font-ttf/issues
22- Online Discussion: https://gitter.im/sutton-signwriting/community
23
24## Installation
25
26## Install TrueType Font
27
28The TrueType Fonts can be installed on Windows, Mac, and Linux. For iOS, [two mobile configurations](https://github.com/Slevinski/signwriting_2010_fonts) are available. Installation is not possible on Android.
29
30### Install with NPM
31```
32 npm install @sutton-signwriting/font-ttf
33```
34
35### Install with GIT
36```
37 # download package
38 git clone https://github.com/sutton-signwriting/font-ttf.git
39
40 # install dependencies
41 cd font-ttf
42 npm install
43
44 # create project documentation
45 npm run docs
46
47 # create project files
48 npm run build
49```
50
51## Usage
52
53### Using as a module
54```
55 // import entire library
56 import * as ttf from '@sutton-signwriting/font-ttf'
57
58 // import individual module
59 import {font} from '@sutton-signwriting/font-ttf'
60```
61
62### Using in the Browser
63
64#### Local files
65```
66 // import entire library
67 // available as ssw.ttf
68 <script src="index.js"></script>
69
70 // import individual module
71 // available as ssw.ttf.font
72 <script src="font/font.js"></script>
73```
74
75#### Unpkg
76```
77 // import entire library
78 // available as ssw.ttf
79 <script src="https://unpkg.com/@sutton-signwriting/font-ttf@1.0.0"></script>
80
81 // import individual module
82 // available as ssw.ttf.font
83 <script src="https://unpkg.com/@sutton-signwriting/font-ttf@1.0.0/font/font.min.js"></script>
84```
85
86## Configure font for VS Code
87
88File >> Preferences >> Settings
89
90Search for "font family". Append SuttonSignWritingOneD to the list of fonts. Restart VS Code.
91
92## License
93MIT
94
95## SignWriting General Interest
96- SignWriting Website: https://signwriting.org/
97- Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
98- Email Discussion: https://www.signwriting.org/forums/swlist/
99- Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/