Merge pull request #41 from ufyTeX/doc-fixes

Doc fixes

README.md

@@ -19,10 +19,17 @@ HarfBuzz is an OpenType text shaping engine. It is used in software like Qt,
 Pango, Firefox, Chromium, XeTeX and LibreOffice.
 
 _luaharfbuzz_ provides bindings for the most common types in Harfbuzz. The
-initial motivation for building it is to use Harfbuzz with the [LuaTeX]
+initial motivation for building it was to use Harfbuzz with the [LuaTeX]
 typesetting system. However, the module isn’t tied to LuaTeX in any way. It
 can be used with any Lua codebase.
 
+luaharfbuzz is currently being used inside [HarfTeX], a TeX engine built
+on top of LuaTeX and designed to use Harfbuzz for shaping text. For more
+details read this TUGboat journal article titled [Bringing world scripts to LuaTEX: The
+HarfBuzz experiment][tugboat-article]
+
+[HarfTeX]: https://github.com/khaledhosny/harftex
+[tugboat-article]: https://tug.org/members/TUGboat/tb40-1/tb124hosny-harfbuzz.pdf
 [LuaTeX]:luatex.org
 
 ## Installing Harfbuzz
@@ -43,9 +50,6 @@ brew install harfbuzz
 apt-get install libharfbuzz0b libharfbuzz-dev
 ```
 
-#### Windows
-Getting the whole setup running on Windows is very tedious, so all instructions are in their own file [README-win.md](https://github.com/deepakjois/luaharfbuzz/blob/master/README-win.md).
-
 #### Other Platforms
 _Send a pull request if you want to include specific instructions to install
 Harfbuzz on your preferred platform._
@@ -139,6 +143,8 @@ In order to make changes to the code and run the tests, the following dependenci
 
 * [Busted](http://olivinelabs.com/busted/) – `luarocks install busted`
 * [luacheck](luacheck.readthedocs.org) – `luarocks install luacheck`
+* [luacov](https://keplerproject.github.io/luacov/) – `luarocks install luacov`
+* [ldoc](https://stevedonovan.github.io/ldoc/) – `luarocks install ldoc`
 
 Run the test suite:
 ```
@@ -150,5 +156,10 @@ Lint the codebase:
 make lint
 ```
 
+Generate documentation from sources:
+```
+make doc
+```
+
 ## Contact
 Open a Github issue, or email me at <deepak.jois@gmail.com>.

config.ld

@@ -1,6 +1,6 @@
 project = 'luaharfbuzz'
 description = 'Lua bindings to Harfbuzz'
-full_description = 'The documentation is available on the @{https://github.com/deepakjois/luaharfbuzz/wiki|wiki}'
+full_description = 'The documentation is available on the @{https://github.com/ufytex/luaharfbuzz/wiki|wiki}'
 use_markdown_titles = true
 backtick_references = false
 title = 'luaharfbuzz Documentation'

docs/examples/core_types.lua.html

@@ -101,7 +101,7 @@ <h2>core_types.lua</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-04-13 17:03:03 </i>
+<i style="float:right;">Last updated 2019-07-31 18:39:39 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/index.html

@@ -66,9 +66,9 @@ <h1>Module <code>harfbuzz</code></h1>
 <p>
 
 <ul>
-    <li><a href="http://github.com/deepakjois/luaharfbuzz/wiki">Wiki</a></li>
-    <li><a href="https://github.com/deepakjois/luaharfbuzz">Source on Github</a></li>
-    <li><a href="https://github.com/deepakjois/luaharfbuzz/blob/master/status/done.txt">API Coverage Status</a></li>
+    <li><a href="http://github.com/ufytex/luaharfbuzz/wiki">Wiki</a></li>
+    <li><a href="https://github.com/ufytex/luaharfbuzz">Source on Github</a></li>
+    <li><a href="https://github.com/ufytex/luaharfbuzz/blob/master/status/done.txt">API Coverage Status</a></li>
 </ul>
 </p>
     <h3>Info:</h3>
@@ -651,7 +651,7 @@ <h3>Parameters:</h3>
     <li><code>language</code>: A <code>Language</code> object representing the language.</li>
     <li><code>features</code>: features to enable, specified as either of the following.
     <ul>
-        <li>comma-separated list of features. See <a href="https://github.com/deepakjois/luaharfbuzz/wiki/Feature-Strings">feature string syntax reference</a></li>
+        <li>comma-separated list of features. See <a href="https://github.com/ufytex/luaharfbuzz/wiki/Feature-Strings">feature string syntax reference</a></li>
         <li>table of <code>Feature</code> objects</li>
     </ul></li>
 </ul>
@@ -1774,7 +1774,7 @@ <h2 class="section-header has-description"><a name="Class_Feature"></a>Class Fea
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">feature_string</span>
-         See <a href="https://github.com/deepakjois/luaharfbuzz/wiki/Feature-Strings">feature string syntax reference</a>
+         See <a href="https://github.com/ufytex/luaharfbuzz/wiki/Feature-Strings">feature string syntax reference</a>
         </li>
     </ul>
 
@@ -2822,7 +2822,7 @@ <h2 class="section-header has-description"><a name="Predefined_Name_IDs"></a>Pre
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-05-01 16:42:35 </i>
+<i style="float:right;">Last updated 2019-07-31 18:39:39 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

src/harfbuzz.luadoc

@@ -1,8 +1,8 @@
 -----------
 -- Lua bindings to Harfbuzz.
--- * [Wiki](http://github.com/deepakjois/luaharfbuzz/wiki)
--- * [Source on Github](https://github.com/deepakjois/luaharfbuzz)
--- * [API Coverage Status](https://github.com/deepakjois/luaharfbuzz/blob/master/status/done.txt)
+-- * [Wiki](http://github.com/ufytex/luaharfbuzz/wiki)
+-- * [Source on Github](https://github.com/ufytex/luaharfbuzz)
+-- * [API Coverage Status](https://github.com/ufytex/luaharfbuzz/blob/master/status/done.txt)
 --
 -- @author Deepak Jois <<deepak.jois@gmail.com>>
 -- @copyright 2016
@@ -23,7 +23,7 @@
 --  * `script`: A `Script` object representing the script.
 --  * `language`: A `Language` object representing the language.
 --  * `features`: features to enable, specified as either of the following.
---    - comma-separated list of features. See [feature string syntax reference](https://github.com/deepakjois/luaharfbuzz/wiki/Feature-Strings)
+--    - comma-separated list of features. See [feature string syntax reference](https://github.com/ufytex/luaharfbuzz/wiki/Feature-Strings)
 --    - table of `Feature` objects
 --  @function shape
 
@@ -291,7 +291,7 @@
 --  @type Feature
 
 --- Wraps `hb_feature_from_string`
---  @param feature_string See [feature string syntax reference](https://github.com/deepakjois/luaharfbuzz/wiki/Feature-Strings)
+--  @param feature_string See [feature string syntax reference](https://github.com/ufytex/luaharfbuzz/wiki/Feature-Strings)
 --  @function Feature.new
 
 --- Wraps `hb_feature_to_string`.