README Signed-off-by: Alain <alainmarcel@yahoo.com>
diff --git a/README.md b/README.md index e20d4d3..a726ee8 100644 --- a/README.md +++ b/README.md
@@ -111,6 +111,23 @@ * 0x1 - Fatal error(s) * 0x2 - Syntax error(s) * 0x4 - Error(s) + +### Python API + + * The file [`slformatmsg.py`](src/API/slformatmsg.py) illustrates how messages can be reformated. + * Place a modified version of this file either in the execution directory, or install directory /usr/local/lib/surelog/python + + * The file [`src/API/slSV3_1aPythonListener.py`](src/API/src/API/slSV3_1aPythonListener.py) illustrates how a listener can be created to listen to the Parser AST. + * Place a modified version of this file either in the execution directory, or install directory /usr/local/lib/surelog/python + + * A simple example of creating a new error message and generating errors can be found here: [`python_listener.py`](src/API/python_listener.py) + + * The complete Python API is described in the following files: [`SLAPI.h`](src/API/SLAPI.h) [`vobjecttypes`](src/API/vobjecttypes.py) + + * Waivers can be installed in slwaivers.py files in the execution directory or install directory /usr/local/lib/surelog/python + +### Creating your own executable using libsurelog.a + * This is discussed in [`src/README`](src/README.md) file. ### Similar projects:
diff --git a/src/API/python_listener.py b/src/API/python_listener.py index ef07414..8f960f8 100644 --- a/src/API/python_listener.py +++ b/src/API/python_listener.py
@@ -1,4 +1,4 @@ -# Sample listener used to test release tar file, used by release.tcl +# Sample listener SLregisterNewErrorType("[NOTE :PY0403]", "Module declaration \"%s\"", ""); SLoverrideSeverity("[NOTE :PY0403]", "INFO")
diff --git a/src/API/surelog.bash b/src/API/surelog.bash deleted file mode 100644 index 253354b..0000000 --- a/src/API/surelog.bash +++ /dev/null
@@ -1,6 +0,0 @@ -#!/bin/bash -# Surelog Bash invocation script -SCRIPTPATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -export LD_LIBRARY_PATH=${SCRIPTPATH}/lib:$LD_LIBRARY_PATH -${SCRIPTPATH}/bin/surelog.exe "$@" -