Skip to content

Commit

Permalink
initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
Slevinski committed Oct 31, 2019
0 parents commit 4bb779e
Show file tree
Hide file tree
Showing 100 changed files with 11,277 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .babelrc
@@ -0,0 +1,12 @@
{
"presets": [
[
"@babel/preset-env",
{
"targets": {
"node": "current"
}
}
]
]
}
9 changes: 9 additions & 0 deletions .gitignore
@@ -0,0 +1,9 @@
.DS_Store
node_modules
/core.*
/fsw
/fswquery
/swu
/swuquery
/style
/convert
15 changes: 15 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,15 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0] - 2019-10-31
### Added
- core modules of fsw, fswquery, swu, swuquery, style, and convert
- documentation for core modules

[Unreleased]: https://github.com/sutton-signwriting/core/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/sutton-signwriting/core/releases/tag/v0.0.1
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License

Copyright (c) 2007-2019 Steve Slevinski https://SteveSlevinski.me

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
65 changes: 65 additions & 0 deletions README.md
@@ -0,0 +1,65 @@
# @sutton-signwriting/core

[![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)

@sutton-signwriting/core is a javascript package for node and browsers that supports general processing of SignWriting text.

This package supports both Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets, along with the associated query languages and style string. See [draft-slevinski-formal-signwriting](https://tools.ietf.org/id/draft-slevinski-formal-signwriting-07.html) for detailed specification.

## Useful links

- GitHub Repo: https://github.com/sutton-signwriting/core
- Documentation: https://sutton-signwriting.github.io/core/
- Issue Tracker: https://github.com/sutton-signwriting/core/issues
- Online Discussion: https://gitter.im/sutton-signwriting/community


## Installation

### Install with NPM

npm install @sutton-signwriting/core

### Download from GitHub

https://github.com/sutton-signwriting/core/archive/master.zip


## Usage

### Using in Node

// import entire library
const core = require('@sutton-signwriting/core);

// import individual module
const fsw = require('@sutton-signwriting/core/fsw);

### Using in the Browser

#### Local files
// import entire library
// available as ssw.core
<script src="core.js"></script>

// import individual module
// available as ssw.fsw
<script src="fsw/fsw.js"></script>

#### Unpkg
// import entire library
// available as ssw.core
<script src="https://unpkg.com/@sutton-signwriting/core"></script>

// import individual module
// available as ssw.fsw
<script src="https://unpkg.com/@sutton-signwriting/core/fsw"></script>

## License
MIT

## SignWriting General Interest
- SignWriting Website: https://signwriting.org/
- Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
- Email Discussion: https://www.signwriting.org/forums/swlist/
- Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/
26 changes: 26 additions & 0 deletions addstyle.js
@@ -0,0 +1,26 @@

// appends CSS styling to documentation output for SignWriting in Unicode (SWU) character font-family.
// alternatively, modify node_modules/dcumentation/src/default-theme/assets/style.css to add styling directly

const fs = require('fs');

const appendStyle = `
@font-face {
font-family: "SuttonSignWritingOneD";
src:
local('SuttonSignWritingOneD'),
url('./SuttonSignWritingOneD.ttf') format('truetype'),
url('https://cdn.rawgit.com/Slevinski/SuttonSignWriting/master/assets/SuttonSignWritingOneD.ttf') format('truetype');
}
.pre,
pre,
code,
.code {
font-family: Source Code Pro, Menlo, Consolas, Liberation Mono, monospace, SuttonSignWritingOneD;
}
`;

fs.appendFile('docs/assets/style.css', appendStyle, function (err) {
if (err) console.log(err);
});

0 comments on commit 4bb779e

Please sign in to comment.