From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Tue, 7 Feb 2006 17:54:41 +0000 (+0000)
Subject: added instructions (some gaps still to be filled in, notably: ./configure
X-Git-Tag: 0.4.95@7852~1701
X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=commitdiff_plain;h=2462b1e4da42c76932f52de9b37aa96cc9a5e4e0;p=helm.git

added instructions (some gaps still to be filled in, notably: ./configure
parameters and instructions on how to create the mysql database)
---

diff --git a/matita/help/C/matita.xml b/matita/help/C/matita.xml
index 4bcdedfb7..ab08a6f9c 100644
--- a/matita/help/C/matita.xml
+++ b/matita/help/C/matita.xml
@@ -13,6 +13,8 @@
   <!ENTITY app "<application>Matita</application>">
   <!ENTITY appname "Matita">
   <!ENTITY appversion SYSTEM "version.txt">
+
+  <!ENTITY TODO "<emphasis>TODO</emphasis>">
 ]>
 
 <!-- =============Document Header ============================= -->
diff --git a/matita/help/C/sec_install.xml b/matita/help/C/sec_install.xml
index 84ce6f0d6..09bc9d740 100644
--- a/matita/help/C/sec_install.xml
+++ b/matita/help/C/sec_install.xml
@@ -227,7 +227,73 @@
 
 	</variablelist> </para>
 
+    </sect3>
+
+    <sect3 id="build_instructions">
+      <title>Instructions</title>
+
+      <para> Once you get the source code the installations steps should be
+	quite familiar.</para>
+
+      <para> First of all you need to configure the build process executing
+	<userinput>./configure</userinput>. This will check that all needed
+	tools and library are installed. You may need to pass on the command
+	line some of the parameters riported below:
+
+	<variablelist>
+	  <title><application>configure</application> parameters</title>
+
+	  <varlistentry>
+	    <term>&TODO;</term>
+	    <listitem>&TODO;</listitem>
+	  </varlistentry>
+
+	</variablelist>
+
+      </para>
+
+      <para> Then you will manage the build process using <application><ulink
+	    type="http"
+	    url="http://www.gnu.org/software/make/">make</ulink></application>
+	as usual. Below are reported the targets you have to invoke in sequence
+	to build and install.
+
+	<variablelist>
+	  <title><application>make</application> targets</title>
+
+	  <varlistentry>
+	    <term><userinput>world</userinput></term>
+	    <listitem>
+	      <para>builds components needed by &appname; and &appname; itself
+		(in bytecode only or in both bytecode and native code depending
+		on the availability of the OCaml native code compiler) </para>
+	    </listitem>
+	  </varlistentry>
 
+	  <varlistentry>
+	    <term><userinput>library</userinput></term>
+	    <listitem>
+	      <para>uses the (just built) <application>matitac</application>
+		compiler to build the &appname; standard library. </para>
+	      <para>For this step you will need a working SQL database (for
+		indexing the standard library while you are compiling it). See
+		&TODO; for instructions on how to set it up.</para>
+	    </listitem>
+	  </varlistentry>
+
+	  <varlistentry>
+	    <term><userinput>install</userinput></term>
+	    <listitem>
+	      <para>installs &appname; related tools, standard library and the
+		needed runtime stuff in the proper places on the filesystem
+	      </para>
+	    </listitem>
+	  </varlistentry>
+
+	</variablelist>
+
+      </para>
+      
     </sect3>
 
   </sect2>