refactoring

[onig] / README

diff --git a/README b/README
index 9f910073390a26e1cbf4419959681b493417e176..90b420dddd6fc6cb803605dfb28f1c20df66f0e1 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,30 @@
-README  2016/04/06
+README  2018/04/05
 
-Oniguruma  ----   (C) K.Kosako <kkosako0@gmail.com>
+Oniguruma  ----   (C) K.Kosako
 
 https://github.com/kkos/oniguruma
 
-Oniguruma is a regular expressions library.
-The characteristics of this library is that different character encoding
-for every regular expression object can be specified.
+FIXED Security Issues (in Oniguruma 6.3.0):
+  CVE-2017-9224, CVE-2017-9225, CVE-2017-9226
+  CVE-2017-9227, CVE-2017-9228, CVE-2017-9229
+
+---
+Oniguruma is a modern and flexible regular expressions library. It
+encompasses features from different regular expression implementations
+that traditionally exist in different languages. It comes close to
+being a complete superset of all regular expression features found
+in other regular expression implementations.
+
+Its features include:
+* Character encoding can be specified per regular expression object.
+* Several regular expression types are supported:
+  * POSIX
+  * Grep
+  * GNU Regex
+  * Perl
+  * Java
+  * Ruby
+  * Emacs
 
 Supported character encodings:
 
@@ -49,20 +67,19 @@ Install
 
 
 
- Case 2: Win32 platform (VC++)
+ Case 2: Windows 64/32bit platform (Visual Studio)
 
-   1. copy win32\Makefile src\Makefile
-   2. copy win32\config.h src\config.h
-   3. cd src
-   4. nmake
+   execute make_win64 or make_win32
 
-      onig_s.lib:  static link library
-      onig.dll:    dynamic link library
+      src/onig_s.lib:  static link library
+      src/onig.dll:    dynamic link library
 
   * test (ASCII/Shift_JIS)
-   1. copy win32\testc.c src\testc.c
-   2. cd src
-   3. nmake ctest
+      1. cd src
+      2. copy ..\windows\testc.c .
+      3. nmake -f Makefile.windows ctest
+
+  (I have checked by Visual Studio Community 2015)
 
 
 
@@ -77,7 +94,7 @@ Usage
   See doc/API for Oniguruma API.
 
   If you want to disable UChar type (== unsigned char) definition
-  in oniguruma.h, define ONIG_ESCAPE_UCHAR_COLLISION and then 
+  in oniguruma.h, define ONIG_ESCAPE_UCHAR_COLLISION and then
   include oniguruma.h.
 
   If you want to disable regex_t type definition in oniguruma.h,
@@ -103,6 +120,7 @@ Sample Programs
   sample/posix.c     POSIX API sample.
   sample/sql.c       example of the variable meta characters.
                      (SQL-like pattern matching)
+  sample/user_property.c  example of user defined Unicode property.
 
 Test Programs
   sample/syntax.c    Perl, Java and ASIS syntax test.
@@ -168,22 +186,10 @@ Source Files
   utf16_le.c         UTF-16LE encoding.
   utf32_be.c         UTF-32BE encoding.
   utf32_le.c         UTF-32LE encoding.
-  unicode.c          Unicode information data.
+  unicode.c          common codes of Unicode encoding.
 
   win32/Makefile     Makefile for Win32 (VC++)
   win32/config.h     config.h for Win32
 
 
-
-ToDo
-
-  ? case fold flag: Katakana <-> Hiragana.
-  ? add ONIG_OPTION_NOTBOS/NOTEOS. (\A, \z, \Z)
- ?? \X (== \PM\pM*)
- ?? implement syntax behavior ONIG_SYN_CONTEXT_INDEP_ANCHORS.
- ?? transmission stopper. (return ONIG_STOP from match_at())
-
 and I'm thankful to Akinori MUSHA.
-
-
-Mail Address: K.Kosako <kkosako0@gmail.com>