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

Commit 7eed182

Browse files
RomainCscnRomainCscn
committed
[FIX] Docs updated with link to github.io
1 parent d58fc83 commit 7eed182

File tree

6 files changed

+34
-30
lines changed

6 files changed

+34
-30
lines changed

‎README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ It integrates all you need:
2525

2626
### Installation
2727

28-
1. Download MyScriptJS library
28+
1. Download MyScriptJS library
2929
```shell
3030
bower install myscript
3131
```
@@ -37,7 +37,6 @@ bower install myscript
3737
<link rel="stylesheet" href="bower_components/myscript/dist/myscript.min.css"/>
3838
<script src="bower_components/myscript/dist/myscript.min.js"></script>
3939
<script src="https://code.jquery.com/pep/0.4.3/pep.js"></script>
40-
4140
```
4241

4342
4. In the `body` tag, create a `div` tag that will contain the editing zone:
@@ -70,7 +69,7 @@ bower install myscript
7069
- [Text recognition and conversion with V3 API](https://myscript.github.io/MyScriptJS/examples/v3/websocket_text.html)
7170
- [**more examples...**](https://myscript.github.io/MyScriptJS/examples/)
7271

73-
The [directory examples/](/examples) of this Git repository contains all the example source codes.
72+
The [directory examples/](https://github.com/MyScript/MyScriptJS/tree/master/examples) of this Git repository contains all the example source codes.
7473

7574
## Documentation
7675

@@ -82,7 +81,7 @@ The API Reference is available in the `docs` directory or on [myscript.github.io
8281

8382
:warning: Master refers to 4.0.x versions of the lib. Consider branch 1.2.x for previous versions of MyScriptJS.
8483

85-
Instructions to help you build the project are available in [SETUP.md](SETUP.md) file.
84+
Instructions to help you build the project are available in [SETUP.md](https://github.com/MyScript/MyScriptJS/blob/master/SETUP.md) file.
8685

8786

8887
## Getting support
@@ -98,4 +97,4 @@ We’re planning to showcase apps using it so let us know by sending a quick mai
9897

9998
We welcome your contributions:
10099
If you would like to extend MyScriptJS for your needs, feel free to fork it!
101-
Please sign our [Contributor License Agreement](CONTRIBUTING.md) before submitting your pull request.
100+
Please sign our [Contributor License Agreement](https://github.com/MyScript/MyScriptJS/blob/master/CONTRIBUTING.md) before submitting your pull request.

‎docs/ast/source/configuration/DefaultConfiguration.js.json

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1532,10 +1532,10 @@
15321532
}
15331533
},
15341534
"extra": {
1535-
"rawValue": 300,
1536-
"raw": "300"
1535+
"rawValue": 100,
1536+
"raw": "100"
15371537
},
1538-
"value": 300
1538+
"value": 100
15391539
}
15401540
},
15411541
{
@@ -1587,10 +1587,10 @@
15871587
}
15881588
},
15891589
"extra": {
1590-
"rawValue": 300,
1591-
"raw": "300"
1590+
"rawValue": 100,
1591+
"raw": "100"
15921592
},
1593-
"value": 300
1593+
"value": 100
15941594
}
15951595
}
15961596
]
@@ -8419,10 +8419,10 @@
84198419
}
84208420
},
84218421
"extra": {
8422-
"rawValue": 300,
8423-
"raw": "300"
8422+
"rawValue": 100,
8423+
"raw": "100"
84248424
},
8425-
"value": 300
8425+
"value": 100
84268426
}
84278427
},
84288428
{
@@ -8474,10 +8474,10 @@
84748474
}
84758475
},
84768476
"extra": {
8477-
"rawValue": 300,
8478-
"raw": "300"
8477+
"rawValue": 100,
8478+
"raw": "100"
84798479
},
8480-
"value": 300
8480+
"value": 100
84818481
}
84828482
}
84838483
]
@@ -17258,7 +17258,7 @@
1725817258
"binop": null,
1725917259
"updateContext": null
1726017260
},
17261-
"value": 300,
17261+
"value": 100,
1726217262
"start": 11000,
1726317263
"end": 11003,
1726417264
"loc": {
@@ -17363,7 +17363,7 @@
1736317363
"binop": null,
1736417364
"updateContext": null
1736517365
},
17366-
"value": 300,
17366+
"value": 100,
1736717367
"start": 11019,
1736817368
"end": 11022,
1736917369
"loc": {

‎docs/dump.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/file/src/configuration/DefaultConfiguration.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -536,8 +536,8 @@
536536
},
537537
renderingParams: {
538538
stroker: &apos;quadratic&apos;,
539-
minHeight: 300,
540-
minWidth: 300
539+
minHeight: 100,
540+
minWidth: 100
541541
},
542542
recognitionParams: {
543543
type: &apos;TEXT&apos;,

‎docs/index.html

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,11 @@
278278
</nav>
279279

280280
<div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><p>:pencil: <strong>MyScriptJS</strong> is the fastest way to integrate rich <strong>handwriting</strong> features in your webapp.</p>
281-
<p><img src="preview.gif" alt="MyScriptJS preview"></p>
281+
<p></p><p>
282+
<img src="preview.gif">
283+
</p>
284+
285+
<p></p>
282286
<h2 id="what-is-it-about-">What is it about?</h2>
283287
<p>MyScriptJS is a JavaScript library that can be used in every web application (whatever JavaScript framework you are using) to bring handwriting recognition. </p>
284288
<p>It integrates all you need: </p>
@@ -296,15 +300,16 @@ <h3 id="prerequisites">Prerequisites</h3>
296300
</ol>
297301
<h3 id="installation">Installation</h3>
298302
<ol>
299-
<li><p>Download MyScriptJS library</p>
303+
<li><p>Download MyScriptJS library </p>
300304
<pre><code class="lang-shell"><code class="source-code prettyprint">bower install myscript</code>
301305
</code></pre>
302306
</li>
303307
<li><p>Create and edit <code>index.html</code> file in the same directory.</p>
304308
</li>
305-
<li><p>Add the following line in the <code>head</code> section ot your file: </p>
309+
<li><p>Add the following lines in the <code>head</code> section ot your file. We use pep to ensure better browsers compatibilities. Note that you can also use it using bower dependencies: </p>
306310
<pre><code class="lang-html"><code class="source-code prettyprint">&lt;link rel=&quot;stylesheet&quot; href=&quot;bower_components/myscript/dist/myscript.min.css&quot;/&gt;
307-
&lt;script src=&quot;bower_components/myscript/dist/myscript.min.js&quot;&gt;&lt;/script&gt;</code>
311+
&lt;script src=&quot;bower_components/myscript/dist/myscript.min.js&quot;&gt;&lt;/script&gt;
312+
&lt;script src=&quot;https://code.jquery.com/pep/0.4.3/pep.js&quot;&gt;&lt;/script&gt;</code>
308313
</code></pre>
309314
</li>
310315
<li><p>In the <code>body</code> tag, create a <code>div</code> tag that will contain the editing zone:</p>
@@ -335,13 +340,13 @@ <h2 id="examples">Examples</h2>
335340
<li><a href="https://myscript.github.io/MyScriptJS/examples/v3/websocket_text.html">Text recognition and conversion with V3 API</a> </li>
336341
<li><a href="https://myscript.github.io/MyScriptJS/examples/"><strong>more examples...</strong></a></li>
337342
</ul>
338-
<p>The <a href="/examples">directory examples/</a> of this Git repository contains all the example source codes. </p>
343+
<p>The <a href="https://github.com/MyScript/MyScriptJS/tree/master/examples">directory examples/</a> of this Git repository contains all the example source codes. </p>
339344
<h2 id="documentation">Documentation</h2>
340345
<p>A complete guide is available on <a href="https://developer.myscript.com/docs/interactive-ink/1.0/web/myscriptjs/">MyScript Developer website</a>.</p>
341346
<p>The API Reference is available in the <code>docs</code> directory or on <a href="https://myscript.github.io/MyScriptJS/">myscript.github.io/MyScriptJS/ website</a>.</p>
342347
<h2 id="building-myscriptjs">Building MyScriptJS</h2>
343348
<p>:warning: Master refers to 4.0.x versions of the lib. Consider branch 1.2.x for previous versions of MyScriptJS.</p>
344-
<p>Instructions to help you build the project are available in <a href="SETUP.md">SETUP.md</a> file.</p>
349+
<p>Instructions to help you build the project are available in <a href="https://github.com/MyScript/MyScriptJS/blob/master/SETUP.md">SETUP.md</a> file.</p>
345350
<h2 id="getting-support">Getting support</h2>
346351
<p>You can get some support from the dedicated section on MyScript Developer website.</p>
347352
<h2 id="sharing-your-feedback-">Sharing your feedback ?</h2>
@@ -350,7 +355,7 @@ <h2 id="sharing-your-feedback-">Sharing your feedback ?</h2>
350355
<h2 id="contributing">Contributing</h2>
351356
<p>We welcome your contributions:
352357
If you would like to extend MyScriptJS for your needs, feel free to fork it!
353-
Please sign our <a href="CONTRIBUTING.md">Contributor License Agreement</a> before submitting your pull request.</p>
358+
Please sign our <a href="https://github.com/MyScript/MyScriptJS/blob/master/CONTRIBUTING.md">Contributor License Agreement</a> before submitting your pull request.</p>
354359
</div>
355360
</div>
356361

‎docs/source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@
341341
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
342342
<td style="display: none;" data-ice="size">14516 byte</td>
343343
<td style="display: none;" data-ice="lines">395</td>
344-
<td style="display: none;" data-ice="updated">2017-09-06 09:54:47 (UTC)</td>
344+
<td style="display: none;" data-ice="updated">2017-10-02 08:24:54 (UTC)</td>
345345
</tr>
346346
<tr data-ice="file">
347347
<td data-ice="filePath"><span><a href="file/src/configuration/DefaultPenStyle.js.html#errorLines=31,36">src/configuration/DefaultPenStyle.js</a></span></td>

0 commit comments

Comments
 (0)