Se agrega un archivo que falto subir en el ultimo commit XD

[z.facultad/75.42/plaqui.git] / docs / mainpage.h

diff --git a/docs/mainpage.h b/docs/mainpage.h
index ec016abd3d4aae6ef2c51e36d9cf92a2c00c97d4..9f7eddf6186f248a362f3ab346fa6f7e41173128 100644 (file)
--- a/docs/mainpage.h
+++ b/docs/mainpage.h
@@ -1,62 +1,67 @@
-/** \mainpage PlaQui
+/** \mainpage Plaqui

 
 \section introduccion Introducción
 
        \subsection herramientas Herramientas Utilizadas
 
 \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
+               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.
+                 [http://glade.gnome.org/]
+               - GCC (3.2.x): Compilador C/C++.
+                 [http://gcc.gnu.org/]
+               - VIM: Editor de texto utilizado para programar.
+                 [http://www.vim.org/]
+               - Doxygen: Generador de documentación y referencias cruzadas.
+                 [http://www.stack.nl/~dimitri/doxygen/]
+               - GNU Make.
+                 [http://www.gnu.org/software/make/]
+               - Automake.
+                 [http://www.gnu.org/software/automake/]
+               - Autoconf.
+                 [http://www.gnu.org/software/autoconf/]

 
        \subsection bibliotecas Bibliotecas Utilizadas
 
        \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++/
+               - 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/]
+               - 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.

-       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
+               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
+               usuario (binaria y sin símbolos para depurar) requiere menos de 2MB de
+               espacio en disco. Para compilarlo (con símbolos para depurar) puede
+               necesitar más de 80MB.

 
 

-       \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
+               \subsubsection requerimientos_minimos Requerimientos mínimos
+                       Esta es la mínima configuración en la que fue probado.
+                       - Procesador: Pentium 75MHz
+                       - Memoria RAM (física y virtual): 32MB
+
+               \subsubsection requerimientos_recomendados Requerimientos recomendados
+                       - 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).
 
        \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).
+       - \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á
        - 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á