| 1 | # @sutton-signwriting/font-db
|
| 2 | [](https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 3 | [](https://www.npmjs.com/package/@sutton-signwriting/font-db)
|
| 4 | [](https://npm-stat.com/charts.html?package=@sutton-signwriting/font-db&from=2019-10-31)
|
| 5 |
|
| 6 | 
|
| 7 |
|
| 8 | @sutton-signwriting/font-db is a javascript package for node that generates SVG and PNG images for individual symbols, complete signs, and structured text. The package covers the entire set of the International SignWritnig Alphabet 2010 (ISWA 2010).
|
| 9 |
|
| 10 | This 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-09.html) for detailed specification.
|
| 11 |
|
| 12 | > Author: https://SteveSlevinski.me
|
| 13 | > Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow
|
| 14 | > Sponsor: https://www.patreon.com/signwriting
|
| 15 | > Donate: https://paypal.me/signwriting
|
| 16 |
|
| 17 | ## Useful links
|
| 18 |
|
| 19 | - GitHub Repo: https://github.com/sutton-signwriting/font-db
|
| 20 | - Documentation: https://www.sutton-signwriting.io/font-db/
|
| 21 | - Issue Tracker: https://github.com/sutton-signwriting/font-db/issues
|
| 22 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
| 23 |
|
| 24 |
|
| 25 | ## Install in existing NPM package
|
| 26 | ```
|
| 27 | npm install @sutton-signwriting/font-db
|
| 28 | ```
|
| 29 |
|
| 30 | ## Install Font Database Package as stand-alone
|
| 31 | ```
|
| 32 | # download package
|
| 33 | git clone https://github.com/sutton-signwriting/font-db.git
|
| 34 |
|
| 35 | # install dependancies
|
| 36 | cd font-db
|
| 37 | npm install
|
| 38 |
|
| 39 | # test project
|
| 40 | npm run test
|
| 41 | npm run testit fsw
|
| 42 | npm run testit fsw-symbol-svg
|
| 43 |
|
| 44 | # create project documentation
|
| 45 | npm run docs
|
| 46 |
|
| 47 | # start built-in server
|
| 48 | npm run server
|
| 49 | ```
|
| 50 |
|
| 51 | ## Usage
|
| 52 |
|
| 53 | ### Using in code
|
| 54 | ```
|
| 55 | // import entire library
|
| 56 | const fontDb = require('@sutton-signwriting/font-db');
|
| 57 |
|
| 58 | // import individual module
|
| 59 | const fsw = require('@sutton-signwriting/font-db/fsw');
|
| 60 | ```
|
| 61 |
|
| 62 | ### Using on the command line
|
| 63 | ```
|
| 64 | # works for script with FSW and SWU, Symbol and Sign, SVG and PNG.
|
| 65 |
|
| 66 | # output in the terminal
|
| 67 | node fsw/fsw-sign-svg M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475-C
|
| 68 |
|
| 69 | # save to file
|
| 70 | node fsw/fsw-sign-svg M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475-C output.svg
|
| 71 | ```
|
| 72 |
|
| 73 | ## License
|
| 74 | MIT
|
| 75 |
|
| 76 | ## SignWriting General Interest
|
| 77 | - SignWriting Website: https://signwriting.org/
|
| 78 | - Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
|
| 79 | - Email Discussion: https://www.signwriting.org/forums/swlist/
|
| 80 | - Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/
|