docs/mainpage.h

   1 /** \mainpage PlaQui
   2
   3 \section introduccion Introducción
   4
   5         \subsection herramientas Herramientas Utilizadas
   6         Aquí tenemos un listado de las herramientas y bibliotecas que estamos
   7         utilizando a fin de poder luego documentar de manera correcta los
   8         requerimientos para instalar y ejecutar el programa, las versiones y los
   9         programas utilizados durante el desarrollo.
  10         - Glade2: Editor RAD para crear interfaces de usuario
  11         - GCC (3.3.x): Compilador C++
  12         - VIM: Editor de texto utilizado para programar
  13         - Doxygen: Generador de documentación y referencias cruzadas
  14         - GNU Make
  15         - Automake
  16         - Autoconf
  17
  18         \subsection bibliotecas Bibliotecas Utilizadas
  19         - Gtkmm ( >= 2.0.0): Warper a C++ de la biblioteca Gtk+
  20           http://www.gtkmm.org/
  21         - Glademm ( >= 2.0.0): Para cargar archivos XML con la UI
  22           http://www.gtkmm.org/
  23         - Glibmm ( >= 2.0.0): Funciones de threads y otras básicas.
  24           http://www.gtkmm.org/
  25         - sigc++ ( >= 1.2.5): Sistema de señales para C++
  26           http://libsigc.sourceforge.net/
  27         - socket++ ( >= 1.12.10): Wrapper de socket portables en C++ streams
  28           http://members.aon.at/hstraub/linux/socket++/
  29
  30         \subsection requerimientos Requerimientos de Hardware y SO.
  31         El trabajo práctico fue desarrollado bajo Debian GNU/Linux sid
  32         (http://www.debian.org/), pero debería andar en cualquier GNU/Linux e
  33         incluso probablemente en otros Unixes (e incluso podría llegar a andar
  34         en WIN32).
  35         \b Cliente:
  36                 - Procesador: PII 400 Mhz
  37                 - Memoria RAM: 64 Mb
  38                 - Espacio en disco: aun no confirmado
  39                 - SO: GNU/Linux
  40
  41         \b Servidor:
  42                 - Procesador: Pentium 75MHz
  43                 - Memoria RAM: 16MB
  44                 - Espacio en disco: 5MB
  45                 - SO: GNU/Linux
  46
  47         \b Constructor:
  48                 - Procesador: PII 400 Mhz
  49                 - Memoria RAM: 64 Mb
  50                 - Espacio en disco: aun no confirmado
  51                 - SO: GNU/Linux
  52
  53         \subsection instalacion Instalación.
  54         El programa se divide en 4 módulos:
  55         - Modelo: es el módulo que se encarga de la simulación y el modelo \c
  56           físico de la planta (es una biblioteca).
  57         - Servidor: es la infrastructura de red. Comprende tanto el servidor
  58           como el cliente en cuando al manejo de la red (es una biblioteca y un
  59           programa).
  60         - Cliente: es el cliente gráfico que permite ver la simulación (es un
  61           programa).
  62         - Constructor: es el programa para diseñar la planta química que será
  63           simulada por el modelo en el servidor (es un programa).
  64
  65         La instalación puede realizarse de dos formas: instalando módulo por
  66         módulo o instalando todos los módulos a la vez.
  67
  68                 \subsubsection instalacion_global Instalación Global
  69                 Para instalar todos los programas es sencillo.
  70                 -# Descomprimir el paquete:
  71                    \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
  72                 -# Entrar al directorio del proyecto:
  73                    \verbatim cd plaqui \endverbatim
  74                 -# Inicializar el proyecto:
  75                    \verbatim aclocal && autoconf && automake -a \endverbatim
  76                 -# Configurar la compilación del proyecto (generalmente basta con):
  77                    \verbatim ./configure \endverbatim
  78                    Esto lo instala por defecto en /usr/local, se puede
  79                    especificar otra ruta con la opcion \c --prefix
  80                 -# Compilar el proyecto:
  81                    \verbatim make \endverbatim
  82                 -# Instalar el proyecto:
  83                    \verbatim make install \endverbatim
  84
  85                 \subsubsection instalacion_global Instalación Por Partes
  86                 El procedimiento es muy similar al anterior:
  87                 -# Descomprimir el paquete:
  88                    \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
  89                 -# Entrar al directorio del módulo [Módulo]:
  90                    \verbatim cd plaqui/[Módulo] \endverbatim
  91                 -# Inicializar el módulo:
  92                    \verbatim aclocal && autoconf && automake -a \endverbatim
  93                 -# Configurar la compilación del módulo (generalmente basta con):
  94                    \verbatim ./configure \endverbatim
  95                 -# Compilar el módulo:
  96                    \verbatim make \endverbatim
  97                 -# Instalar el módulo:
  98                    \verbatim make install \endverbatim
  99
 100 \section mainpage_servidor Servidor
 101         Puede ver la documentación del servidor en \ref page_server
 102
 103 */