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