New README file. Clarification about Autotools in INSTALL.

diff --git a/INSTALL b/INSTALL
index f934759ac2637f9bf87b7d1da6a6c01ce7c68260..da5940e05cecd5ae8c82677702eeb5c4a74f7fe1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -100,10 +100,15 @@ make install
 3. Building InterAspect
 ---
 
-InterAspect also use Autoconf and Automake, so the build process is
+InterAspect also uses Autoconf and Automake, so the build process is
 similar.  You can build it directly from the main project directory or
 from a separate build directory (as we did with GCC).
 
+[NB: If you obtained these sources from our git repository, Autotools
+is not yet set up.  Run the bootstrap.sh script before trying to
+configure and compile.  We recommend tarball source distributions for
+most users because they come with Autotools already set up.]
+
 Note that there are two GCCs involved in the InterAspect build
 process: the GCC that will compile the InterAspect source (the host
 compiler) and the GCC that will use InterAspect plug-ins (the target

diff --git a/README b/README
index ad129eb265d6c8297f15c2f08d8dde71a18561d2..fc47331f6cafea88ac1eed5918a3b23d7cbb81f6 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,19 @@
------------------------------
-InterAspect Preview Release
------------------------------
+InterAspect is a program-instrumentation framework for GCC developed
+at Stony Brook University as part of the Survivable Software project.
+Using InterAspect, it is possible to write plug-ins for GCC that
+instrument compiled programs with calls to advice functions.
 
-This is a prerelease version of software that is intended for future
-release as GPLed software.
+Important files and directories:
 
-There are two important sources of documentation included in this
-distribution:
+  - docs/html/: Extensive documentation for the InterAspect API.  You
+    may need to run the command
 
-1: INSTALL
-  A comprehensive guide for installing a plug-in capable GCC and for
-  building the InterAspect library.
+    doxygen
 
-2: doc/html/index.html
-  The (as yet incomplete) API documentation generated with Doxygen.
+    from the main InterAspect directory to generate documentation.
+  - INSTALL: Comprehensive instructions for compiling InterAspect
+    along with most of its dependencies.
+  - COPYING: Full text of InterAspect's license, the GNU General
+    Public License version 3 (GPLv3).
+  - COPYING.RUNTIME: GCC's "Runtime Exception" to the GPLv3, which
+    also applies to InterAspect.