[m-dev.] Opium-M documentation

[Erwan Jahier]

| Hi Erwan,
| 
| The documentation in extras/opium_m/README is a bit too sparse, IMHO.
| In particular, it should say
| 	- what Opium-M is
| 	- that Opium-M requires ECLiPSe
| 	- what ECLiPSe is and where you can get it
| 	- how to find more documentation on Opium-M
| 	- the URL for the Opium-M web site, if there is one

You are rigth, thanks. I've just copied and pasted the informations contained in the 
Opium-M web site. See the diff below.
 
| Also the file extras/opium_m/copyright.txt still contains "XXX"
| in a couple of places.  You may want to fix that.

Sure.

I am still in the process with the administrative people at IRISA and INSA to 
put Opium-M into a GPL framework. They agreed in principle. I was waiting for 
an official letter saying it explicitly.

How much time do I have to do that? i.e. when do you plan to release?


--
Estimated hours taken: 0.5

opium_m/README:
	Update the content of that file.


Index: README
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/opium_m/README,v
retrieving revision 1.1
diff -u -r1.1 README
--- README	1999/11/11 04:52:01	1.1
+++ README	1999/12/13 09:43:43
@@ -1,30 +1,54 @@
-# Copyright (C) 1999 INRIA/INSA.
 
+* Opium-M, a debugger/trace analyser for Mercury
 
-To install Opium-M, unzip and de-tar the file Opium-M-*.tar.gz, and run the
-script INSTALL-OPIUM-M. This will create in the scripts/ directory the
-script Opium-M that let you run Opium-M. 
+Program execution traces given by traditional debuggers provide programmers
+with useful pieces of information. However, using them requires to analyse by
+hand huge amounts of information. Opium-M is connected to the traditional
+tracer of Mercury; it allows execution trace analyses to be automated. It
+provides a relational trace query language based on Prolog which enables users
+to specify precisely what they want to see in the trace. Opium-M, then,
+automatically filters out information irrelevant for the users.
 
-Add directories scripts/ and bin/ in your PATH environment variable. Make sure
-that the executables mmc and eclipse are also accessible from your PATH.
+Opium-M provides users a langage to write their own debugging primitives
+(Prolog + 2 primitives connected the Mercury trace system) and their own
+monitors (see the `collect' command).
 
+				-o-
 
-The current release of Opium-M has been tested with the following
-configurations:
-- Architecture: sparc/Solaris2.[5,6,7] and i686/Linux2.0
-- ECLiPSe: 4.1 and later (1).
-- Mercury: later than 1999-03-12 release of the day.
+* Opium-M installation
 
-(1) make sure that the package eclipse_misc.tgz has been downloaded (i.e. if
-there exists a directory named `lib_pd' in the ECLiPSe installation directory);
-Opium-M needs it.
+To install Opium-M, you just need to:
 
-(*) If you use one of those versions of ECLiPSe, you will need to add the
-following line in your .opium-m-rc file (that should be in your home
-directory): 
-":- set_parameter(socket_domain, [inet])."
+1) Run the script `INSTALL-OPIUM-M' (that creates the `Opium-M' script in 
+   the `opium_m/scripts/' directory).
+2) Add directories ` opium_m/scripts/' and `opium_m/bin/' in your `PATH' 
+   environment variable. Make sure that the executables `mmc' and `eclipse' 
+   are also accessible from your `PATH'. 
 
-This is to work around a bug in ECLiPSe socket interface that has been fixed in
-version 4.1.
+
+Note that Opium-M requires ECLiPSe, a Prolog system which is free to
+universities and non-profit research institutions. You can download it at
+`http://www.icparc.ic.ac.uk/eclipse/'. Also make sure that the package
+eclipse_misc.tgz has been downloaded (i.e. if there exists a directory named
+`lib_pd' in the ECLiPSe installation directory); Opium-M needs it.
+
+Opium-M does not require Mercury to be installed, but you might also want to
+install it ;-)
+
+				-o-
+
+* The current release of Opium-M has been tested with the following 
+  configurations: 
+
+o Architectures: sparc/Solaris2.[5,6,7] and i686/Linux2.0
+o ECLiPSe 4.1 or later (1
+o Mercury: later than 1999-15-10 release of the day.
+
+				-o-
+
+For more information about Opium-M, you can have a look at the Opium-M
+web site:
+
+http://www.irisa.fr/lande/jahier/download.html
 
 				-o-
-------------- next part --------------
R1.