X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/blobdiff_plain/d46988670a776e174147fc0cce35652383177785..4341c033f13578b5b3aeb3e08e20d3889cb2d7c7:/docs/mainpage.h?ds=sidebyside
diff --git a/docs/mainpage.h b/docs/mainpage.h
index 6939d24..a369335 100644
--- a/docs/mainpage.h
+++ b/docs/mainpage.h
@@ -1,4 +1,4 @@
-/** \mainpage PlaQui
+/** \mainpage Plaqui
\section introduccion Introducción
@@ -31,10 +31,14 @@
[http://www.gtkmm.org/]
- sigc++ ( >= 1.2.5): Sistema de señales para C++
[http://libsigc.sourceforge.net/]
+ - libxml2 ( >= 0.15.0): Parser de XML.
+ [http://xmlsoft.org/]
+ - libxm++ ( >= 0.15.0): Wrapper de libxml2 para C++.
+ [http://libxmlplusplus.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.
+ \subsection requerimientos Requerimientos de Hardware y SO
PlaQui 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). La versión para el
@@ -51,54 +55,73 @@
- Procesador: PII 400 Mhz
- Memoria RAM: 64 MB
- \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).
- - \ref page_server "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.
+ \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).
+ - \ref page_server "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
+ 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 --prefix.
+ -# Compilar el proyecto:
+ \verbatim make \endverbatim
+ -# Instalar el proyecto:
+ \verbatim make install \endverbatim
+
+ \note Para realizar el último paso, dependiendo de si usó la
+ opción --prefix o no, es posible que necesite
+ permisos de superusuario (root).
\subsubsection instalacion_global Instalación Por Partes
- El procedimiento es muy similar al anterior:
- -# Descomprimir el paquete:
- \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
- -# Entrar al directorio del módulo [Módulo]:
- \verbatim cd plaqui/[Módulo] \endverbatim
- -# 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
+ El procedimiento es muy similar al anterior:
+ -# Descomprimir el paquete:
+ \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
+ -# Entrar al directorio del módulo [Módulo]:
+ \verbatim cd plaqui/[Módulo] \endverbatim
+ -# 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
+
+ \note Para realizar el último paso, dependiendo de si usó la
+ opción --prefix o no, es posible que necesite
+ permisos de superusuario (root).
\section mainpage_servidor Servidor
Puede ver la documentación del servidor en \ref page_server
*/
+
+/** \namespace PlaQui
+
+Diseñador, simulador y controlador de plantas químicas distribuido.
+
+El Programa se divide en 4 módulos. Los módulo que se comportan como
+biblioteca compartida tienen a su vez un espacio de nombres (namespace)
+anidado: PlaQui::Model y PlaQui::Server.
+
+*/
+