<?xml version="1.0" standalone="no"?>
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.1.2//EN' 		     
'http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd' [ 
<!ENTITY nice "Nice">
<!ENTITY java "Java">
]>
<page>
<title>Installing the &nice; compiler</title>

<description>
Installing the Nice compiler
</description>

<keywords>
nice, compiler, install, windows, debian, linux, unix, eclipse
</keywords>

<para>
Select your system:

<itemizedlist>

<listitem><para>
<inlinemediaobject><imageobject>
<imagedata fileref="images/eclipse.png"/>
</imageobject></inlinemediaobject>

<link linkend="eclipse">Eclipse</link>

</para></listitem>
<listitem><para>

<inlinemediaobject><imageobject>
<imagedata fileref="images/debian.png"/>
</imageobject></inlinemediaobject>

<link linkend="deb">Debian</link>

</para></listitem>
<listitem><para>

<inlinemediaobject><imageobject>
<imagedata fileref="images/redhat.png"/>
</imageobject></inlinemediaobject>

<link linkend="rpm">Redhat or 
<inlinemediaobject><imageobject>
<imagedata fileref="images/mandrake.png"/>
</imageobject></inlinemediaobject>
Mandrake Linux (rpm)</link>

</para></listitem>
<listitem><para>

<inlinemediaobject><imageobject>
<imagedata fileref="images/linux.png"/>
</imageobject></inlinemediaobject>

<link linkend="unix">Unix</link>

</para></listitem>
<listitem><para>

<inlinemediaobject><imageobject>
<imagedata fileref="images/win32.png"/>
</imageobject></inlinemediaobject>

<link linkend="win">Windows</link>

</para></listitem>
<listitem><para>

<inlinemediaobject><imageobject>
<imagedata fileref="images/unknown.png"/>
</imageobject></inlinemediaobject>

<link linkend="other">Other</link>

</para></listitem>
<listitem><para>

<inlinemediaobject><imageobject>
<imagedata fileref="images/dev-32.png"/>
</imageobject></inlinemediaobject>

<link linkend="source">Source distribution</link>

</para></listitem>
</itemizedlist>

</para>


<section id="eclipse"><title>Eclipse</title>
<para>
Nice can be installed inside the 
<ulink url="http://eclipse.org">eclipse</ulink> development platform. 
Download the <ulink 
url="http://sf.net/project/showfiles.php?group_id=12788&amp;package_id=94229">
plugin zip file</ulink>, and unzip it inside the <literal>plugins</literal>
sub-directory of your eclipse directory.
The Nice plugin works for versions 2.1 and 3.0 of eclipse, and it includes
the Nice compiler, so you don't need to install it separately.
</para>
</section>

<section id="deb"><title>Debian Linux</title>
<para>
Nice is in the Debian archive, so you can
simply <literal>apt-get install nice</literal>.
Alternatively, you can download the 
<ulink url="nice.deb">Debian package</ulink> from this site
and install it with <literal>dpkg -i nice_*.deb</literal>.
</para>
</section>

<section id="rpm"><title>Redhat or Mandrake Linux (rpm)</title>
<para>
Simply download the <ulink url="nice.rpm">RPM package</ulink>
and install it with <literal>rpm -i Nice_*.rpm</literal>.
</para>
</section>

<section id="unix"><title>Unix</title>
<para>
Download the <ulink url="Nice.tar">Nice.tar.gz</ulink> file and
save it as <literal>/tmp/Nice.tar.gz</literal>.
</para>

<variablelist>
<varlistentry><term>System installation (if you are root)</term>
<listitem>
<para>
Uncompress the archive:
<programlisting>
cd /usr/local
tar zxf /tmp/Nice.tar.gz
</programlisting>
</para>
</listitem>
</varlistentry>

<varlistentry><term>User installation</term>
<listitem>
<para>
Uncompress the archive in your home directory:
<programlisting>
cd
tar zxf /tmp/Nice.tar.gz
</programlisting>
The &nice; tools are placed in the <literal>bin</literal> subdirectory. 
It is be a good idea to include it in your <literal>PATH</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>

<para>
That's it! &nice; automatically recognizes where it is installed.
</para>

<para>
If you use Emacs, you should also 
<link linkend="emacs">install the &nice; mode</link>.
</para>
</section>

<section id="win"><title>Windows</title>
<para>
Download <ulink url="Nice.zip">Nice.zip</ulink> and decompress it into
<literal>C:\</literal>. A <literal>Nice</literal> subdirectory will be created.
Then read the documentation in 
<ulink url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/nice/Nice/web/Readme.txt&quest;rev=HEAD&amp;content-type=text/plain"><literal>Readme.txt</literal></ulink>.
</para>

<para>
<ulink url="http://www.gnu.org/software/emacs/windows/">Emacs for Windows</ulink> is a good editor for Nice programs (and many other things!). 
If you use it, 
you should also <link linkend="emacs">install the &nice; mode</link>.
</para>
</section>

<section id="other"><title>Other systems</title>
<para>
There are no specific instructions for other operating systems.
However &nice; can be used on any system that works with &java;.
If you are in this situation, please 
<ulink url="mailto:bonniot@users.sourceforge.net">contact me</ulink>
to share your experience and augment the documentation.
</para>
</section>

<section id="source"><title>Source distribution</title>
<para>
it is also possible to 
<ulink url="Nice-source.tar.gz">download the source code</ulink> of Nice,
together with a bootstrap compiler. 
Compilation is done by simply typing <literal>make</literal>.
</para>
</section>

<section id="emacs"><title>Emacs mode for Nice</title>
<para>
There is an <ulink url="http://www.gnu.org/software/emacs/">Emacs</ulink> mode
for &nice; which makes Emacs the editor of choice for &nice; programs!
To enable it, place this in your <literal>.emacs</literal> file:
<programlisting>
;; Nice mode
;; If you installed Nice in your home directory,
;; then remove the leading ; in the next line 

;(setq load-path (cons "~/share/emacs/site-lisp/nice" load-path))
(setq auto-mode-alist 
  (cons '("\\.nice$" . nice-mode) auto-mode-alist))
(autoload 'nice-mode "nice-mode" 
  "Major mode for editing Nice programs." t)
</programlisting>

The first line is there to ensure that the <literal>nice-mode.el</literal> file
is in your Emacs <literal>load-path</literal>. 
You may also do that by moving the file to some standard directory. 
Or you may have to replace <literal>~</literal> by <literal>/usr</literal>
or <literal>/usr/local</literal> depending on where you installed Nice.
</para>
<para>
The &nice; mode will then be loaded automatically when you open 
<literal>.nice</literal> files. 
Type <literal>C-h m</literal> for the documentation of the mode.
</para>
</section>

</page>