feat: release v1.0.0

* chore: add table data
* chore: update executables
* refactor: split UnicodeData
* rename: UnicodeTool to lookup
* feat: use table lookup
* feat: add canonical decomposition mapping
* feat: add table lookup
* feat: add Noncharacter_Code_Point
* feat: add table generator
* feat: add `PG` and `PQ` derived categories
* feat: add Hangul syllable decomposition functions
* feat: add testTables utility to test lookup tables
* feat: add expanded table for `Canonical_Decomposition_Mapping`
* feat: add table for `Decomposition_Mapping`
* feat: add UnicodeDataStream to UnicodeData
* feat: add `getCanonicalCombiningClass`
* chore: test and update lookup tables
* chore: update lakefile
* chore: documentation

Author: fgdorais

.github/workflows/build.yml

@@ -15,5 +15,5 @@ jobs:
       - uses: actions/checkout@v4
       - uses: leanprover/lean-action@v1.0.0
         with:
-          test: false
+          test: true
           use-mathlib-cache: false

README.md

@@ -1,28 +1,45 @@
 # Lean 4 / Unicode Basic
 
-Lightweight Unicode support for Lean 4.
+Unicode support for Lean 4.
 
-Unicode properties that are currently supported are:
+Unicode properties that are currently supported by `UnicodeBasic` include:
 
 * `Alphabetic`
-* `Bidi_Class`, `Bidi_Control`, and `Bidi_Mirrored`
+* `Bidi_Class`
+* `Bidi_Control`
+* `Bidi_Mirrored`
 * `Canonical_Combining_Class`
-* `Uppercase`, `Lowercase`, `Cased` and `Case_Ignorable`
-* `Decomposition_Type` and `Decomposition_Mapping`
+* `Case_Ignorable`
+* `Cased`
+* `Decomposition_Mapping`
+* `Decomposition_Type`
 * `General_Category`
 * `Hex_Digit`
 * `Math`
 * `Name`
-* `Numeric_Type` and `Numeric_Value`
-* `Simple_Lowercase_Mapping`, `Simple_Uppercase_Mapping`, and `Simple_Titlecase_Mapping`
+* `Numeric_Type`
+* `Numeric_Value`
+* `Simple_Lowercase_Mapping`
+* `Simple_Uppercase_Mapping`
+* `Simple_Titlecase_Mapping`
+* `Lowercase`
+* `Uppercase`
 * `White_Space`
 
-To keep the library lightweight, only properties that can be derived exclusively from `UnicodeData.txt` and `PropList.txt` can be supported.
-If you need a property not yet in the list above, please submit a feature request!
+To keep the `UnicodeLibrary` library lightweight, only commonly used properties can be supported. If you need a property not yet in the list above, please submit a feature request!
 
 ## Installation
 
-Add the following dependency to your project's `lakefile.lean`:
+Add the following dependency to your project's `lakefile.toml`:
+
+```toml
+[[require]]
+name = "UnicodeBasic"
+git = "https://github.com/fgdorais/lean4-unicode-basic.git"
+rev = "main"
+```
+
+Or your project's `lakefile.lean`:
 
 ```lean
 require UnicodeBasic from git
@@ -43,5 +60,5 @@ The remaining files are implementation details. Some of these may be of interest
 
 -----
 
-* The `Lean 4 / Unicode Basic` library is copyright © 2023 François G. Dorais. The library is released under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0). See the file LICENSE for additional details.
-* The `UnicodeData.txt` and `PropList.txt` files are copyright © 1991-2023 Unicode, Inc. The files are distributed under the [Unicode® Copyright and Terms of Use](https://www.unicode.org/copyright.html). See the file LICENSE-UNICODE for additional details.
+* The `Lean 4 / Unicode Basic` library is copyright © 2023-2024 François G. Dorais. The library is released under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0). See the file LICENSE for additional details.
+* The `UnicodeData.txt` and `PropList.txt` files are copyright © 1991-2024 Unicode, Inc. The files are distributed under the [Unicode® Copyright and Terms of Use](https://www.unicode.org/copyright.html). See the file LICENSE-UNICODE for additional details.