1:- use_package(assertions).    2
    3:- doc(filetype, documentation).    4
    5:- doc(author, "Joaquin Arias").    6
    7:- doc(title,"Installation").    8
    9:- doc(module, "
   10
   11@section{Quick installation}
   12Requirements
   13@begin{enumerate}
   14@item Ciao (visit @href{http://ciao-lang.org})
   15@end{enumerate}
   16
   17@section{Build and installation}
   18
   19
   20You can automatically fetch, build, and install this bundle using:
   21
   22@begin{verbatim}
   23ciao get gitlab.software.imdea.org/joaquin.arias/sCASP
   24@end{verbatim}
   25
   26This command stores the source and generates the binaries in the Ciao
   27_workspace directory_. This directory is given by the value of the
   28`CIAOPATH` environment variable (or `~/.ciao` if unspecified).
   29
   30Binaries are placed in the `$CIAOPATH/build/bin` directory (or
   31`~/.ciao/build/bin`). To call a binary without specifying its full
   32path it is recommended to include this directory in your `PATH`:
   33
   34@begin{verbatim}
   35export PATH=$CIAOPATH/build/bin:$PATH
   36# or export PATH=~/.ciao/build/bin:$PATH
   37@end{verbatim}
   38
   39@section{Installation for developers}
   40
   41For installing s(CASP) independently from CIAO clone this repository
   42wherever you want (e.g., ~/devel/).
   43
   44    cd ~/devel
   45    git clone git@gitlab.software.imdea.org:joaquin.arias/sCASP.git
   46
   47Compile it using the Makefile.
   48
   49    cd scasp
   50    make compile_scasp
   51
   52To call a binary without specifying its full path it is recommended to
   53include this directory in your `PATH`:
   54
   55@begin{verbatim}
   56export PATH=~/devel/scasp:$PATH
   57@end{verbatim}
   58
   59").