r3585: *** empty log message ***

[hyperobject.git] / doc / intro.sgml

diff --git a/doc/intro.sgml b/doc/intro.sgml
new file mode 100644 (file)
index 0000000..6a9e666
--- /dev/null
+++ b/doc/intro.sgml
@@ -0,0 +1,73 @@
+<!-- -*- DocBook -*- -->
+
+<chapter>
+  <title>Introduction</title>
+  <sect1>
+    <title>Purpose</title>
+    <para> This reference guide describes
+      &hyperobject;, which provides an object representation
+      library for Common Lisp programs. 
+    </para>
+  </sect1>
+
+  <sect1>
+    <title>Supported Implementations</title> 
+    <para>The primary tested and supported platforms for &hyperobject; are: 
+    </para>
+    <itemizedlist mark="opencircle">
+      <listitem><para>&acl; v6.2</para></listitem>
+      <listitem><para>&lw; v4.2</para></listitem>
+      <listitem><para>&cmucl; 18d</para></listitem>
+      <listitem><para>&sbcl; 0.7.10</para></listitem>
+      <listitem><para>&scl; 1.1.1</para></listitem>
+    </itemizedlist>
+  </sect1>
+
+  <sect1>
+  <title>Installation</title>
+  <sect2>
+    <title>Download</title>
+    <para>
+You need to download the &hyperobject; package from its web
+<ulink url="http://hyperobject.b9.com"><citetitle>home</citetitle></ulink>.
+Other require packages are:</para> 
+<itemizedlist mark="opencircle">
+<listitem><para>&kmrcl; from it's <ulink url="ftp://kmrcl.b9.com"><citetitle>home</citetitle></ulink>.</para></listitem>
+<listitem><para>&uffi; from it's <ulink url="http://uffi.b9.com"><citetitle>home</citetitle></ulink>.</para></listitem>
+<listitem><para>&clsql; from it's <ulink url="ftp://clsql.b9.com"><citetitle>home</citetitle></ulink>.</para></listitem>
+<itemizedlist><para>&asdf; from it's home  <ulink url="http://www.sourceforge.net/projects/cclan"><citetitle>CCLAN</citetitle></ulink> package. You can download
+the file <filename>asdf.lisp</filename> from the CVS 
+<ulink url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf/asdf.lisp"><citetitle>tree</citetitle></ulink>.
+    </para>
+</itemizedlist>
+  </sect2>     
+  <sect1>
+    <title>Loading</title>
+    <para>
+      After downloading and installing &asdf;, simply
+      <function>push</function> the
+      directories containing &hyperobject;, &kmrcl;, &uffi;, and &clsql; onto
+      <varname>asdf:*central-registry*</varname> variable. Whenever you
+want to load the &hyperobject; package, use the function
+      <computeroutput>(asdf:oos 'asdf:load-op :hyperobject)</computeroutput>.
+    </para>
+  </sect1>
+</appendix>
+
+    <sect1>
+      <title>Design</title>
+      <sect2>
+       <title>Overview</title>
+       <para>
+         &hyperobject; was designed as a cross-implementation 
+         compatible <emphasis>Foreign Function Interface</emphasis>.
+         Necessarily,
+         only a common subset of functionality can be
+         provided. Likewise, not every optimization for that a specific
+         implementation provides can be supported. Wherever possible,
+         though, implementation-specific optimizations are invoked.
+       </para> 
+      </sect2>
+
+      </sect1>
+</chapter>