| 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 and complete signs. 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-07.html) for detailed specification.
|
| 11 |
|
| 12 | ## Useful links
|
| 13 |
|
| 14 | - GitHub Repo: https://github.com/sutton-signwriting/font-db
|
| 15 | - Documentation: https://sutton-signwriting.github.io/font-db/
|
| 16 | - Issue Tracker: https://github.com/sutton-signwriting/font-db/issues
|
| 17 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
| 18 |
|
| 19 |
|
| 20 | ## Install in existing NPM package
|
| 21 | ```
|
| 22 | npm install @sutton-signwriting/font-db
|
| 23 | ```
|
| 24 |
|
| 25 | ## Install Font Database Package as stand-alone
|
| 26 | ```
|
| 27 | # download package
|
| 28 | git clone https://github.com/sutton-signwriting/font-db.git
|
| 29 |
|
| 30 | # install dependancies
|
| 31 | cd font-db
|
| 32 | npm install
|
| 33 |
|
| 34 | # test project
|
| 35 | npm run test
|
| 36 |
|
| 37 | # create project documentation
|
| 38 | npm run docs
|
| 39 |
|
| 40 | # start built-in server
|
| 41 | npm run server
|
| 42 | ```
|
| 43 |
|
| 44 | ## Usage
|
| 45 |
|
| 46 | ### Using in code
|
| 47 | ```
|
| 48 | // import entire library
|
| 49 | const fontDb = require('@sutton-signwriting/font-db);
|
| 50 |
|
| 51 | // import individual module
|
| 52 | const fsw = require('@sutton-signwriting/font-db/fsw);
|
| 53 | ```
|
| 54 |
|
| 55 | ### Using on the commad line
|
| 56 | ```
|
| 57 | # works for script with FSW and SWU, Symbol and Sign, SVG and PNG.
|
| 58 |
|
| 59 | # output in the terminal
|
| 60 | node fsw/fsw-sign-svg M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475-C
|
| 61 |
|
| 62 | # save to file
|
| 63 | node fsw/fsw-sign-svg M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475-C output.svg
|
| 64 | ```
|
| 65 |
|
| 66 | ## License
|
| 67 | MIT
|
| 68 |
|
| 69 | ## SignWriting General Interest
|
| 70 | - SignWriting Website: https://signwriting.org/
|
| 71 | - Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
|
| 72 | - Email Discussion: https://www.signwriting.org/forums/swlist/
|
| 73 | - Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/
|