diff options
author | Hugo Ruscitti <hugoruscitti@gmail.com> | 2012-10-31 20:04:54 (GMT) |
---|---|---|
committer | Hugo Ruscitti <hugoruscitti@gmail.com> | 2012-10-31 20:04:54 (GMT) |
commit | 1890098e05e21aa11269cd7eb47758c33540d7b4 (patch) | |
tree | 0d82a2e8477aa6ee7b1691574780d8995c914a96 | |
parent | c58d53514b7d057ef093f9f1d10444d760d661e3 (diff) |
Creando el archivo README.
-rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..90bca87 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +Research HDN +============ + + +Documentación +------------- + +La documentación del proyecto está en el directorio 'doc/source', el +documento principal es 'doc/source/index.rst'. + +Para generar la versión HTML de toda la documentación, hay que ejecutar +los siguientes comandos: + + cd doc + make html + firefox build/html/index.html + +Ten en cuenta que necesitas instalar 'sphinx' antes de continuar: + + sudo easy_install -U sphinx |