]> granicus.if.org Git - re2c/commitdiff
Updated README in libre2c (added a warning that the library is not maintained).
authorUlya Trofimovich <skvadrik@gmail.com>
Sun, 28 Oct 2018 09:53:14 +0000 (09:53 +0000)
committerUlya Trofimovich <skvadrik@gmail.com>
Sun, 28 Oct 2018 09:53:14 +0000 (09:53 +0000)
libre2c/README

index 540efa5376a6da7622baaab651a46f3fb8e1203e..3eff5466edc5c9d661df792e4b6078a794c0fe8c 100644 (file)
@@ -1,17 +1,28 @@
-re2c Library README
+re2c library
+--------------------------------------------------------------------------------
 
+*** WARNING ***
+At the moment the library is not maintained.
 
-This is a library intended to make it easier to use re2c scanners.
 
+USAGE
+--------------------------------------------------------------------------------
+This is a library intended to make it easier to use re2c scanners.
 To use the library, just copy the re2c directory into your project tree.
-See examples/skeleton for a quick way to get started.
+--------------------------------------------------------------------------------
 
-To view the documentation:
 
-       $ make docs
-       $ www-browser docs/html/index.html
+DOCUMENTATION
+--------------------------------------------------------------------------------
+    $ make docs
+    $ www-browser docs/html/index.html
+
+See examples/skeleton for a quick way to get started.
+--------------------------------------------------------------------------------
 
-You can also view the documentation online at http://u32.net/re2c
 
+LICENSE
+--------------------------------------------------------------------------------
 All code in this library, like re2c itself, is released to the public domain.
+--------------------------------------------------------------------------------