From a7668bfaddc65c27c11f28323a5a3327521c646b Mon Sep 17 00:00:00 2001 From: clay_shooter Date: Fri, 13 Oct 2006 23:29:26 +0000 Subject: [PATCH] Updating documentation --- README.txt | 4 +++ build.xml | 71 ++++++++++++++++++++++++++++----------- docs/HowToBuild.html | 80 ++++++++++++++++++++++++++++++++++++++++++++ docs/HowToBuild.txt | 50 --------------------------- 4 files changed, 135 insertions(+), 70 deletions(-) create mode 100644 docs/HowToBuild.html delete mode 100644 docs/HowToBuild.txt diff --git a/README.txt b/README.txt index d656636..3b90842 100644 --- a/README.txt +++ b/README.txt @@ -1,3 +1,7 @@ + Information about what's new in this release can be found in docs/ReleaseNotes.html + Instructions on building this project can be found in docs/HowToBuild.html +Detailed instructions on creating a build configuration file are in build.xml + This project is hosted on Sourceforge http://sourceforge.net/project/jacob-project diff --git a/build.xml b/build.xml index e616187..7c4bda2 100644 --- a/build.xml +++ b/build.xml @@ -1,32 +1,46 @@ + + + + + + + + @@ -168,16 +184,31 @@ + + + + + + + + + + + + + - + - + + + @@ -195,7 +226,7 @@ - + diff --git a/docs/HowToBuild.html b/docs/HowToBuild.html new file mode 100644 index 0000000..1a596c7 --- /dev/null +++ b/docs/HowToBuild.html @@ -0,0 +1,80 @@ + + +

Development Environment

+The simplest installation involves MS Visual C++ 6.0, Eclipse 3.1 and JDK 1.4. +In that situation, you would just create the compilation_tools.properties +using the example build.xml as a template. All of the releases, up through 1.11, +were built using Visual C++ 6.0. +
    +
  • Microsoft Visual C++ 6.0 and it's included library. (to D:\apps in my case) +
  • Eclipse 3.1 or later from www.eclipse.org. +
  • Java JDK 1.4 (this was built using 1.4.2.09) +
+ +

+A more complicated set up would involve: +

    +
  • Microsoft Visual Studio 2005 Express, available from the MS web site.
    + if you get an mspdb80.dll not found then you didn't set the environment variables + %PATH% during the install. You can either add the Common\IDE directory to your path in + the EnvironmentVariables configuration panel or you can do a quick hack (like I did). + You can just copy Common7\IDE\*.dll to VC\bin. +
  • Microsoft SDK with the following components +
      +
    • Windows Core SDK +
    • Microsoft Web Workshop (IE) SDK is required because it is referenced in atlbase.h +
    • (optional) Some folks also install the Debugging tools. +
    + +
  • Eclipse 3.1 or later from www.eclipse.org. +
  • Java JDK 1.4 (this was built using 1.4.2.09) +
+Compilation using JDK 1.5 has not been tested +

Build Process

+This project has been converted completely from MAKE to ANT. You can +run ANT from inside of eclipse or from the command line. +The ant process is driven off of a configuration file named +compilation_tools.properties that describes the locations of the JDK and Microsoft +C++ tools. The build.xml file in the root directory contains examples of the contents +of this file. + +

+Running ANT via build.xml will do the following with the default target. +

    +
  • Build the Java code +
  • Build the jni code +
  • create the dll +
  • create jar file +
+ +Running the "package" ANT target runs the above listed steps and then +builds the javadoc and then the zip files. +

+

Eclipse Java IDE

+

+Eclipse users will have to do some minor tweaks to their project if they +want to use the integrated build process. This is because the unit +tests are files located in the "unittest" directory while +the project source files themselves are in "src" the root directory. +

    + +
  • Eclipse automatically adds the whole project as a source directory +
  • Remove the root of the project from the build path +
  • Add folders samples, src and unittest to the build path +
  • Exclude *.txt from each of the newly added folders. +
+ +

Repository Organization

+

+Unpack the source archive or check the files out of CVS into d:\jacob +

+The java code is in .\src.
+The C++ code is in .\jni. +

+The Servlet examples that required j2ee libraries to compile have temporarily +been removed. +

+Last Modified 10/2005 + + + \ No newline at end of file diff --git a/docs/HowToBuild.txt b/docs/HowToBuild.txt deleted file mode 100644 index 73bc010..0000000 --- a/docs/HowToBuild.txt +++ /dev/null @@ -1,50 +0,0 @@ -To build and run: - -Unpack the source archive or check the files out of CVS into d:\jacob - -Install the following tools - Microsoft Visual C++ 2005 Express Edition, free from Microsoft on their web site. - Eclipse from www.eclipse.org. - Java JDK 1.4 (this was built using 1.4.2.09) - - -This project has been converted completely from MAKE to ANT. You can -run ANT from inside of eclipse or from the command line. -The ant process is driven off of a configuration file named -compilation_tools.properties that describes the locations of the JDK and Microsoft -C++ tools. Instructions on the information required -in that file are contained in build.xml in the root directory. - -The following configuration used by the development team -using VC++ 6.0 installed in D:\apps: - JDK=d:/j2sdk1.4.2_09 - MSDEVDIR=d:\\apps\\Microsoft Visual Studio\\VC98 - version=1.11-pre1 - -Running ANT via build.xml will do the following with the default target. - Build the Java code - Build the jni code - create the dll - create jar file - -Running the "package" ANT target runs the above listed steps and then -builds the javadoc and then the zip files. - -ECLIPSE - -Eclipse users will have to do some minor tweaks to their project if they -want to use the integrated build process. This is because the unit -tests are files located in the "unittest" directory while -the project source files themselves are in "src" the root directory. - Eclipse automatically adds the whole project as a source directory - Remove the root of the project from the build path - Add folders samples, src and unittest to the build path - Exclude *.txt from each of the newly added folders. - -The Servlet examples that required j2ee libraries to compile have temporarily -been removed. - -The java code is in .\src. -The C++ code is in .\jni. - -Last Modified 10/2005