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                   [http://glade.gnome.org/]
  12                 - GCC (3.2.x): Compilador C/C++.
  13                   [http://gcc.gnu.org/]
  14                 - VIM: Editor de texto utilizado para programar.
  15                   [http://www.vim.org/]
  16                 - Doxygen: Generador de documentación y referencias cruzadas.
  17                   [http://www.stack.nl/~dimitri/doxygen/]
  18                 - GNU Make.
  19                   [http://www.gnu.org/software/make/]
  20                 - Automake.
  21                   [http://www.gnu.org/software/automake/]
  22                 - Autoconf.
  23                   [http://www.gnu.org/software/autoconf/]
  24
  25         \subsection bibliotecas Bibliotecas Utilizadas
  26                 - Gtkmm ( >= 2.0.0): Warper a C++ de la biblioteca Gtk+
  27                   [http://www.gtkmm.org/]
  28                 - Glademm ( >= 2.0.0): Para cargar archivos XML con la UI
  29                   [http://www.gtkmm.org/]
  30                 - Glibmm ( >= 2.0.0): Funciones de threads y otras básicas.
  31                   [http://www.gtkmm.org/]
  32                 - sigc++ ( >= 1.2.5): Sistema de señales para C++
  33                   [http://libsigc.sourceforge.net/]
  34                 - socket++ ( >= 1.12.10): Wrapper de socket portables en C++ streams
  35                   [http://members.aon.at/hstraub/linux/socket++/]
  36
  37         \subsection requerimientos Requerimientos de Hardware y SO.
  38                 PlaQui fue desarrollado bajo Debian GNU/Linux sid (http://www.debian.org/),
  39                 pero debería andar en cualquier GNU/Linux e incluso probablemente en otros
  40                 Unixes (e incluso podría llegar a andar en WIN32). La versión para el
  41                 usuario (binaria y sin símbolos para depurar) requiere menos de 2MB de
  42                 espacio en disco. Para compilarlo (con símbolos para depurar) puede
  43                 necesitar más de 80MB.
  44
  45                 \subsubsection requerimientos_minimos Requerimientos mínimos
  46                         Esta es la mínima configuración en la que fue probado.
  47                         - Procesador: Pentium 75MHz
  48                         - Memoria RAM (física y virtual): 32MB
  49
  50                 \subsubsection requerimientos_recomendados Requerimientos recomendados
  51                         - Procesador: PII 400 Mhz
  52                         - Memoria RAM: 64 MB
  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         - \ref page_server "Servidor": es la infrastructura de red. Comprende tanto
  59           el servidor como el cliente en cuando al manejo de la red (es una
  60           biblioteca y un  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:
  88                 -# Descomprimir el paquete:
  89                    \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
  90                 -# Entrar al directorio del módulo [Módulo]:
  91                    \verbatim cd plaqui/[Módulo] \endverbatim
  92                 -# Inicializar el módulo:
  93                    \verbatim aclocal && autoconf && automake -a \endverbatim
  94                 -# Configurar la compilación del módulo (generalmente basta con):
  95                    \verbatim ./configure \endverbatim
  96                 -# Compilar el módulo:
  97                    \verbatim make \endverbatim
  98                 -# Instalar el módulo:
  99                    \verbatim make install \endverbatim
 100
 101 \section mainpage_servidor Servidor
 102         Puede ver la documentación del servidor en \ref page_server
 103
 104 */