]> granicus.if.org Git - fribidi/commitdiff
Preparing for release 1.0.0.
authorDov Grobgeld <dov.grobgeld@gmail.com>
Sat, 27 Jan 2018 21:40:52 +0000 (23:40 +0200)
committerDov Grobgeld <dov.grobgeld@gmail.com>
Sat, 27 Jan 2018 21:41:31 +0000 (23:41 +0200)
NEWS
README.md
configure.ac

diff --git a/NEWS b/NEWS
index 9d255754ce511f13dd7142368792632139d64b95..5e5e664072e0d843429036b79b059046b40c9f5e 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,7 +1,13 @@
-Overview of changes between 0.19.6 and 0.19.8
+Overview of changes between 0.19.7 and 1.0
 =============================================
-* Full isolate and parenthesis support as per Unicode 6.3
-* This version is not backwards compatible.
+
+* Full isolate and parenthesis support as per Unicode 6.3 to Unicode 10.0 . 
+* To get access to the new algorithm calls to the function
+  `fribidi_get_par_embedding_levels()` must be replaced with calls to
+  `fribidi_get_par_embedding_levels_ex()`. These function are not API
+  compatible. Calling the older function will use default values for
+  the new bracket properties and will sometimes yield non-complient
+  results.
 
 Overview of changes between 0.19.6 and 0.19.7
 =============================================
index faa53fe07dff0bef7033833a3266e52ef99df667..fd74fce400933b64497dcf35a15fbfcfaa5a15f3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -60,7 +60,7 @@ You should have received a copy of the GNU Lesser General Public License along
 with GNU FriBidi, in a file named COPYING; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-For licensing issues, contact <license@farsiweb.info>.
+For licensing issues, contact <fribidi.license@gmail.com>.
 
 
 ## Implementation
@@ -85,13 +85,12 @@ machines.
 
 GNU Fribidi has been tested exhaustively against the [Unicode Reference Code],
 and to the best of our knowledge, it completely conforms to the specification,
-always producing the same result as the Reference Code, except for [Mirroring]
-additions, introduced in Unicode 6.3.0 of the specification.
+always producing the same result as the Reference Code.
 
 
 ### API
 
-The reordering of characters is typically done through the function:
+The simplest way of accessing the API is through the convenience function `fribibidi_log2vis` which has the following signature:
 
 ```c
 fribidi_boolean fribidi_log2vis(
@@ -127,6 +126,11 @@ Where...
 If any of the output pointers is equal to `NULL`, then that information is not
 calculated.
 
+Note that a call to `fribidi_log2vis()` is a convenience function to calling the following three functions in order:
+
+1. `fribidi_get_bidi_types()`
+2. `fribidi_get_par_embedding_levels_ex()`
+3. `fribidi_reorder_line()`
 
 ## How it looks like
 
@@ -159,8 +163,8 @@ questions: <https://lists.freedesktop.org/mailman/listinfo/fribidi>
 
 ## Maintainers and Contributors
 
-* Dov Grobgeld <dov.grobgeld@gmail.com>
-* Behdad Esfahbod <behdad@gnu.org>
+* Dov Grobgeld <dov.grobgeld@gmail.com> - Original author and current maintainer
+* Behdad Esfahbod <behdad@gnu.org> - Author of most of the code
 
 See also [`AUTHORS`](./AUTHORS) and [`THANKS`](./THANKS) for the complete list
 of contributors.
index 363346d56c96a58806aaeceb6537d1076e6103ce..312bdeb311e567dbdb2ba0897b6b87cf43d9efab 100644 (file)
@@ -19,9 +19,9 @@ dnl
 dnl If binary backwards compatibility has been broken:
 dnl   FRIBIDI_BINARY_AGE = FRIBIDI_INTERFACE_AGE = 0;
 dnl
-m4_define(fribidi_major_version, 0)dnl
-m4_define(fribidi_minor_version, 19)dnl
-m4_define(fribidi_micro_version, 8)dnl
+m4_define(fribidi_major_version, 1)dnl
+m4_define(fribidi_minor_version, 0)dnl
+m4_define(fribidi_micro_version, 0)dnl
 m4_define(fribidi_interface_version, 4)dnl
 m4_define(fribidi_interface_age, 0)dnl
 m4_define(fribidi_binary_age, 4)dnl