README for building and using SMPStaticAnalyzer plugin

.gitattributes

 * text=auto !eol
 /Build.sh -text
+/README.txt -text
 /SMPStaticAnalyzer.cpp -text
 /makefile -text
 /plugin.script -text

README.txt

+The files in this directory implement the SMPStaticAnalyzer IDA Pro
+plugin for the NICECAP SMP project.
+
+NICECAP = National Intelligence Community Enterprise Computing
+Assurance Program
+
+SMP = Software Memory Protection
+
+1) BUILDING THE STATIC ANALYZER PLUGIN
+
+The variable IDAROOT in file "makefile" will need to be edited to suit
+your IDA Pro installation. $IDAROOT should be the directory with
+executables idal.exe, idaw.exe, and idag.exe. Often, though not
+necessarily, this will be the location with subdirectory SDK
+where the plugin development SDK is installed.
+
+The current value is $HOME/idastd, which matches the IDA Pro
+installation on the user account "nicecap" as set up for common use by
+SMP team members.
+
+The building of an IDA Pro plugin requires the SDK/include files. The
+standard arrangement is to have an SDK/myplugins directory that holds
+the Build.sh, makefile, plugin.script, and *.cpp
+(e.g. SMPStaticAnalyzer.cpp) files. Thus, to build the plugin from
+source, you would copy these files into the myplugins directory and
+then type "Build.sh" there. The plugin builds and is copied into
+$IDAROOT/plugins where it is automatically loaded by IDA Pro.
+
+2) RUNNING THE STATIC ANALYZER ON AN EXECUTABLE
+
+The file SMP-analyze.sh is invoked to run the plugin on an
+executable. To analyze foo.exe, copy SMP-analyze.sh into whatever
+directory you wish to work from, then type:
+
+SMP-analyze.sh foo.exe
+
+The resulting annotations will be found in "foo.annot" in the same
+directory you worked from.
+
+NOTE: Currently, SMP is only targeted to x86/Linux.
+
+Clark Coleman
+25-OCT-2007