Skip to content
This repository was archived by the owner on Jan 4, 2021. It is now read-only.

Commit 6671304

Browse files
Francois-Xavier Gentilhommeystreibel
Francois-Xavier Gentilhomme
authored and
ystreibel
committed
[RELEASE] GitHub release 1.1.0
1 parent 0b6a94e commit 6671304

File tree

210 files changed

+11939
-17348
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+11939
-17348
lines changed

‎Gruntfile.js

+25-13
Original file line numberDiff line numberDiff line change
@@ -173,22 +173,22 @@ module.exports = function (grunt) {
173173
}
174174
},
175175
copy: {
176-
template: {
176+
css: {
177177
files: [{
178178
expand: true,
179179
dot: true,
180-
cwd: '<%= bowerrc.directory %>/yuidoc-bootstrap3-theme/dist',
181-
dest: '<%= project.tmp %>',
182-
src: ['**']
180+
cwd: '.',
181+
dest: '<%= project.dist %>',
182+
src: ['<%= pkg.name %>.css']
183183
}]
184184
},
185185
styles: {
186186
files: [{
187187
expand: true,
188188
dot: true,
189-
cwd: '<%= project.resources %>/<%= project.docs %>/styles',
190-
dest: '<%= project.tmp %>/assets',
191-
src: ['**']
189+
cwd: '<%= project.resources %>/<%= project.docs %>/assets',
190+
dest: '<%= project.dist %>/<%= project.docs %>/assets',
191+
src: ['**/*']
192192
}]
193193
},
194194
conf: {
@@ -206,7 +206,7 @@ module.exports = function (grunt) {
206206
dot: true,
207207
cwd: '<%= project.dist %>',
208208
dest: '<%= project.resources %>/<%= project.samples %>/lib',
209-
src: ['<%= pkg.name %>.js']
209+
src: ['<%= pkg.name %>.js', '<%= pkg.name %>.css']
210210
}]
211211
}
212212
},
@@ -222,12 +222,21 @@ module.exports = function (grunt) {
222222
paths: '<%= project.src %>',
223223
outdir: '<%= project.dist %>/<%= project.docs %>',
224224
linkNatives: 'true',
225-
tabtospace: 2,
226-
themedir: '<%= project.tmp %>',
227-
helpers: ['<%= project.resources %>/<%= project.docs %>/helpers.js']
225+
tabtospace: 2
228226
}
229227
}
230228
},
229+
cssmin: {
230+
target: {
231+
files: [{
232+
expand: true,
233+
cwd: '<%= project.dist %>',
234+
src: ['*.css', '!*.min.css'],
235+
dest: '<%= project.dist %>',
236+
ext: '.min.css'
237+
}]
238+
}
239+
},
231240
compress: {
232241
tgz: {
233242
options: {
@@ -238,6 +247,7 @@ module.exports = function (grunt) {
238247
flatten: true,
239248
cwd: '',
240249
src: [
250+
'<%= project.dist %>/<%= pkg.name %>.css',
241251
'<%= project.dist %>/<%= pkg.name %>.js',
242252
'<%= project.dist %>/<%= pkg.name %>.js.map',
243253
'<%= project.dist %>/<%= pkg.name %>.min.js',
@@ -257,6 +267,7 @@ module.exports = function (grunt) {
257267
flatten: true,
258268
cwd: '',
259269
src: [
270+
'<%= project.dist %>/<%= pkg.name %>.css',
260271
'<%= project.dist %>/<%= pkg.name %>.js',
261272
'<%= project.dist %>/<%= pkg.name %>.js.map',
262273
'<%= project.dist %>/<%= pkg.name %>.min.js',
@@ -350,16 +361,17 @@ module.exports = function (grunt) {
350361
'clean:tmp',
351362
'concat',
352363
'uglify',
364+
'copy:css',
365+
'cssmin',
353366
'copy:resources',
354367
'clean:tmp'
355368
]);
356369

357370
grunt.registerTask('docs', [
358371
'clean:tmp',
359-
'copy:template',
360-
'copy:styles',
361372
'copy:conf',
362373
'yuidoc',
374+
'copy:styles',
363375
'clean:tmp'
364376
]);
365377

‎README.md

+4-42
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,8 @@
11
# MyScriptJS
22

3-
[MyScriptJS](http://myscript.github.io/MyScriptJS/) is a free and open-source JavaScript library providing the easiest way to use the [MyScript Cloud](https://dev.myscript.com/) handwriting recognition service in your app.
4-
5-
[![Build Status](https://travis-ci.org/MyScript/MyScriptJS.svg?branch=master)](https://travis-ci.org/MyScript/MyScriptJS)
6-
[![GitHub version](https://badge.fury.io/gh/MyScript%2FMyScriptJS.svg)](http://badge.fury.io/gh/MyScript%2FMyScriptJS)
7-
[![Bower version](https://badge.fury.io/bo/myscript.svg)](http://badge.fury.io/bo/myscript)
8-
[![npm version](https://badge.fury.io/js/myscript.svg)](http://badge.fury.io/js/myscript)
9-
10-
[MyScriptJS](http://myscript.github.io/MyScriptJS/) speeds up the development of handwriting interfaces with JavaScript, by abstracting and providing default implementations for the common tasks that need to be managed:
11-
12-
* **Ink management**: Store strokes and benefit from a built-in undo/redo system.
13-
* **Ink rendering**: Attach a renderer to a HTML5 canvas to start capturing and displaying smooth strokes.
14-
* **Call to the recognizer**: MyScriptJS manages requests to MyScript Cloud as well as API calls, using HTTP/REST or WebSocket protocols (new in Cloud 3.0).
15-
* **All MyScript recognition types**: The object model of MyScriptJS supports the recognition of handwritten text, shapes, music notation and mathematical expressions.
16-
* **Result tree parsing**: The recognition result tree is exposed and fully traversable.
17-
* **Typesetting (coming soon)**: Replace ink with digital equivalent, whether it is text, music, shapes or mathematical expressions.
18-
19-
Learn more on MyScriptJS in the [Developer Guide](http://doc.myscript.com/MyScriptJS/1.0/index.html) and [API Reference Guide](http://doc.myscript.com/MyScriptJS/1.0/reference/index.html).
20-
21-
22-
## Installation
23-
24-
**Browser**: Use our [CDN](https://cdnjs.com/libraries/myscript) or [Download](https://github.com/MyScript/MyScriptJS/releases/latest) the latest `myscript.js`
25-
26-
**Bower**: `bower install myscript`
27-
28-
**Node**: `npm install myscript`
29-
30-
31-
## Start using MyScriptJS
32-
33-
MyScriptJS requires a valid [MyScript Developer account](https://dev.myscript.com/) (sign up, then go to **Dashboard** and click **CDK samples** to accept the CDK Terms and Conditions).
34-
35-
Check our [Getting Started](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples#getting-started) tutorial to start building your first app.
36-
37-
You are free to use MyScriptJS in any of your personal or commercial project, as permitted by the [Apache 2.0](LICENSE) License.
38-
39-
40-
## Examples
41-
42-
Checking the [code samples](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples) is a good way to start implementing MyScriptJS in your project and to get familiar with the concepts.
43-
3+
## What is it about ?
4+
If you want to add handwriting recognition to your webapp please consider [myscript-math-web](http://github.com/myscript-math-web) and [myscript-text-web](http://github.com/myscript-math-web) based on MyScriptJS.
5+
If you need more customization please take time to read the [developer guide](http://dev.myscript.com).
446

457
## Contribute
468

@@ -53,4 +15,4 @@ Please sign our [Contributor License Agreement](CONTRIBUTING.md) before submitti
5315

5416
Made a cool app with MyScriptJS? We would love to hear about you!
5517

56-
We’re planning to showcase apps using MyScriptJS so let us know by sending a quick mail to [[email protected]](mailto://[email protected])
18+
We’re planning to showcase apps using it so let us know by sending a quick mail to [[email protected]](mailto://[email protected])

‎bower.json

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "myscript",
3-
"version": "1.0.15",
4-
"main": "./dist/myscript.js",
3+
"version": "1.1.0",
4+
"main": ["./dist/myscript.js", "./dist/myscript.css"],
55
"description": "The JavaScript library for the MyScript Cloud recognition service",
66
"keywords": [
77
"myscript",
@@ -12,30 +12,28 @@
1212
"cloud"
1313
],
1414
"license": "Apache-2.0",
15-
"homepage": "http://myscript.github.io/MyScriptJS/",
15+
"homepage": "https://myscript.github.io/MyScriptJS/",
1616
"repository": {
1717
"type": "git",
1818
"url": "git://github.com/MyScript/MyScriptJS.git"
1919
},
2020
"ignore": [
2121
"**/.*",
22+
"package.json",
2223
"node_modules",
2324
"bower_components",
2425
"test",
25-
"docs",
26-
"samples",
26+
"resources",
2727
"docker",
2828
"Makefile",
2929
"Gruntfile.js",
3030
"build.json",
3131
"dist/docs",
3232
"dist/samples"
3333
],
34-
"devDependencies": {
35-
"yuidoc-bootstrap3-theme": "0.0.x"
36-
},
3734
"dependencies": {
3835
"cryptojslib": "3.1.x",
39-
"q": "1.2.x"
36+
"q": "1.4.x",
37+
"handjs": "*"
4038
}
4139
}

‎build.json

+8-12
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@
44
"src/common/generic/quadraticPoint.js",
55
"src/common/generic/rectangle.js",
66
"src/common/inkManager.js",
7+
"src/common/penParameters.js",
8+
"src/common/renderingParameters.js",
79
"src/common/mathUtils.js",
810
"src/common/abstractWSMessage.js",
911
"src/input/generic/components/abstractComponent.js",
1012
"src/input/generic/components/stroke.js",
13+
"src/input/generic/components/strokeComponent.js",
1114
"src/input/generic/components/characterInputComponent.js",
1215
"src/input/generic/components/characterInputComponentAlternate.js",
1316
"src/input/generic/abstractParameter.js",
@@ -40,13 +43,9 @@
4043
"src/input/music/components/abstractMusicInputComponent.js",
4144
"src/input/music/components/musicAccidentalInputComponent.js",
4245
"src/input/music/components/musicArpeggiateInputComponent.js",
43-
"src/input/music/components/musicBarInput.js",
4446
"src/input/music/components/musicBarInputComponent.js",
45-
"src/input/music/components/musicBeamInput.js",
4647
"src/input/music/components/musicBeamInputComponent.js",
47-
"src/input/music/components/musicClefInput.js",
4848
"src/input/music/components/musicClefInputComponent.js",
49-
"src/input/music/components/musicDecorationInput.js",
5049
"src/input/music/components/musicDecorationInputComponent.js",
5150
"src/input/music/components/musicDotsInputComponent.js",
5251
"src/input/music/components/musicHeadInputComponent.js",
@@ -67,17 +66,12 @@
6766
"src/output/generic/challengeResponseWSMessage.js",
6867
"src/output/generic/errorResponseWSMessage.js",
6968
"src/output/generic/initResponseWSMessage.js",
69+
"src/output/generic/resetResponseWSMessage.js",
7070
"src/output/text/textInkRange.js",
7171
"src/output/text/textCandidate.js",
72-
"src/output/text/textCharCandidate.js",
73-
"src/output/text/textWordCandidate.js",
74-
"src/output/text/textResultCandidate.js",
7572
"src/output/text/textDocument.js",
7673
"src/output/text/textResult.js",
7774
"src/output/text/textSegment.js",
78-
"src/output/text/textCharSegment.js",
79-
"src/output/text/textWordSegment.js",
80-
"src/output/text/textResultSegment.js",
8175
"src/output/text/textTagItem.js",
8276
"src/output/text/textResponseWSMessage.js",
8377
"src/output/shape/abstractShapePrimitive.js",
@@ -164,6 +158,7 @@
164158
"src/output/analyzer/analyzerUnderline.js",
165159
"src/output/analyzer/analyzerUnderlineData.js",
166160
"src/networking/networkInterface.js",
161+
"src/networking/networkWSInterface.js",
167162
"src/recognition/abstractRecognizer.js",
168163
"src/recognition/abstractWSRecognizer.js",
169164
"src/recognition/textRecognizer.js",
@@ -173,11 +168,12 @@
173168
"src/recognition/mathWSRecognizer.js",
174169
"src/recognition/musicRecognizer.js",
175170
"src/recognition/analyzerRecognizer.js",
176-
"src/rendering/renderingParameters.js",
177171
"src/rendering/abstractRenderer.js",
178172
"src/rendering/textRenderer.js",
179173
"src/rendering/shapeRenderer.js",
180174
"src/rendering/mathRenderer.js",
181175
"src/rendering/musicRenderer.js",
182-
"src/rendering/analyzerRenderer.js"
176+
"src/rendering/analyzerRenderer.js",
177+
"src/rendering/inkGrabber.js",
178+
"src/inkPaper.js"
183179
]

‎dist/myscript.css

+10
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)