summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul McGuire <ptmcg@users.noreply.github.com>2018-07-20 06:31:02 -0500
committerGitHub <noreply@github.com>2018-07-20 06:31:02 -0500
commit8da759898768311ad3a67a1963d6132f138469a1 (patch)
tree334d61758a78f488d44bba1c07f00a2f4b9a1b98
parent81f9f6eddfa16a84fec6d8d18daf7bb7382a0cbe (diff)
downloadpyparsing-git-8da759898768311ad3a67a1963d6132f138469a1.tar.gz
Update and rename README to README.md
-rw-r--r--README.md (renamed from README)69
1 files changed, 34 insertions, 35 deletions
diff --git a/README b/README.md
index dc959ec..8374854 100644
--- a/README
+++ b/README.md
@@ -1,9 +1,8 @@
-====================================
-PyParsing -- A Python Parsing Module
-====================================
-
-Introduction
-============
+PyParsing -- A Python Parsing Module
+====================================
+
+Introduction
+============
The pyparsing module is an alternative approach to creating and executing
simple grammars, vs. the traditional lex/yacc approach, or the use of
@@ -11,7 +10,7 @@ regular expressions. The pyparsing module provides a library of classes
that client code uses to construct the grammar directly in Python code.
Here is a program to parse "Hello, World!" (or any greeting of the form
-"<salutation>, <addressee>!"):
+"salutation, addressee!"):
from pyparsing import Word, alphas
greet = Word( alphas ) + "," + Word( alphas ) + "!"
@@ -39,18 +38,18 @@ vexing when writing text parsers:
The .zip file includes examples of a simple SQL parser, simple CORBA IDL
parser, a config file parser, a chemical formula parser, and a four-
function algebraic notation parser. It also includes a simple how-to
-document, and a UML class diagram of the library's classes.
-
-
-
-Installation
-============
-
-Do the usual:
-
+document, and a UML class diagram of the library's classes.
+
+
+
+Installation
+============
+
+Do the usual:
+
python setup.py install
-(pyparsing requires Python 2.6 or later.)
+(pyparsing requires Python 2.6 or later.)
Or corresponding commands using pip, easy_install, or wheel:
@@ -59,22 +58,22 @@ Or corresponding commands using pip, easy_install, or wheel:
easy_install pyparsing
wheel install pyparsing
-
-
-Documentation
-=============
-
-See:
-
- HowToUsePyparsing.html
-
-
-License
-=======
-
- MIT License. See header of pyparsing.py
-
-History
-=======
-
+
+
+Documentation
+=============
+
+See:
+
+ HowToUsePyparsing.html
+
+
+License
+=======
+
+ MIT License. See header of pyparsing.py
+
+History
+=======
+
See CHANGES file.