Se agrega docs de instalación.

diff --git a/Doxyfile b/Doxyfile
index 9df9e13b520cbc49bf19183d8e2c8638a60658ca..e51da7485fe9d36ac90d21b2a5616167ca445ab0 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -75,7 +75,8 @@ INPUT                  = Server/src \
                          Model/src \
                          Model/include \
                          Constructor/src \
-                         Constructor/include
+                         Constructor/include \
+                         docs
 FILE_PATTERNS          = *.cpp \
                          *.h
 RECURSIVE              = YES

diff --git a/docs/mainpage.h b/docs/mainpage.h
new file mode 100644 (file)
index 0000000..b667a73
--- /dev/null
+++ b/docs/mainpage.h
@@ -0,0 +1,103 @@
+/** \mainpage PlaQui
+
+\section introduccion Introducción
+
+       \subsection herramientas Herramientas Utilizadas
+       Aquí tenemos un listado de las herramientas y bibliotecas que estamos
+       utilizando a fin de poder luego documentar de manera correcta los
+       requerimientos para instalar y ejecutar el programa, las versiones y los
+       programas utilizados durante el desarrollo.
+
+       - Glade2: Editor RAD para crear interfaces de usuario
+       - GCC (3.3.x): Compilador C++
+       - VIM: Editor de texto utilizado para programar
+       - Doxygen: Generador de documentación y referencias cruzadas
+       - GNU Make
+       - Automake
+       - Autoconf
+
+       \subsection bibliotecas Bibliotecas Utilizadas
+       - Gtkmm ( >= 2.0.0): Warper a C++ de la biblioteca Gtk+
+         http://www.gtkmm.org/
+       - Glademm ( >= 2.0.0): Para cargar archivos XML con la UI
+         http://www.gtkmm.org/
+       - Glibmm ( >= 2.0.0): Funciones de threads y otras básicas.
+         http://www.gtkmm.org/
+       - sigc++ ( >= 1.2.5): Sistema de señales para C++
+         http://libsigc.sourceforge.net/
+       - socket++ ( >= 1.12.10): Wrapper de socket portables en C++ streams
+         http://members.aon.at/hstraub/linux/socket++/
+
+       \subsection requerimientos Requerimientos de Hardware y SO.
+       El trabajo práctico fue desarrollado bajo Debian GNU/Linux sid
+       (http://www.debian.org/), pero debería andar en cualquier GNU/Linux e
+       incluso probablemente en otros Unixes (e incluso podría llegar a andar
+       en WIN32).
+       \b Cliente:
+               - Procesador: PII 400 Mhz
+               - Memoria RAM: 64 Mb
+               - Espacio en disco: aun no confirmado
+               - SO: GNU/Linux
+
+       \b Servidor:
+               - Procesador: Pentium 75MHz
+               - Memoria RAM: 16MB
+               - Espacio en disco: 5MB
+               - SO: GNU/Linux
+               
+       \b Constructor:
+               - Procesador: PII 400 Mhz
+               - Memoria RAM: 64 Mb
+               - Espacio en disco: aun no confirmado
+               - SO: GNU/Linux
+
+       \subsection instalacion Instalación.
+       El programa se divide en 4 módulos:
+       - Modelo: es el módulo que se encarga de la simulación y el modelo \c
+         físico de la planta (es una biblioteca).
+       - Servidor: es la infrastructura de red. Comprende tanto el servidor
+         como el cliente en cuando al manejo de la red (es una biblioteca y un
+         programa).
+       - Cliente: es el cliente gráfico que permite ver la simulación (es un
+         programa).
+       - Constructor: es el programa para diseñar la planta química que será
+         simulada por el modelo en el servidor (es un programa).
+
+       La instalación puede realizarse de dos formas: instalando módulo por
+       módulo o instalando todos los módulos a la vez.
+
+               \subsubsection instalacion_global Instalación Global
+               Para instalar todos los programas es sencillo.
+               - Descomprimir el paquete:
+                 \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
+               - Entrar al directorio del proyecto:
+                 \verbatim cd plaqui \endverbatim
+               - Inicializar el proyecto:
+                 \verbatim aclocal && autoconf && automake -a \endverbatim
+               - Configurar la compilación del proyecto (generalmente basta con):
+                 \verbatim ./configure \endverbatim
+                 Esto lo instala por defecto en /usr/local, se puede
+                 especificar otra ruta con la opcion \c --prefix
+               - Compilar el proyecto:
+                 \verbatim make \endverbatim
+               - Instalar el proyecto:
+                 \verbatim make install \endverbatim
+
+               \subsubsection instalacion_global Instalación Por Partes
+               El procedimiento es muy similar al anterior. Los dos primeros
+               pasos son iguales al método anterior. Para cada modulo se debe
+               hacer el siguiente paso extra:
+               - Entrar al directorio del módulo [Módulo]:
+                 \verbatim cd [Módulo] \endverbatim
+               Y luego seguir como con el método anterior:
+               - Inicializar el módulo:
+                 \verbatim aclocal && autoconf && automake -a \endverbatim
+               - Configurar la compilación del módulo (generalmente basta con):
+                 \verbatim ./configure \endverbatim
+               - Compilar el módulo:
+                 \verbatim make \endverbatim
+               - Instalar el módulo:
+                 \verbatim make install \endverbatim
+
+
+*/