Agrego leeme

3 files changed, 66 insertions, 1 deletions

diff --git a/LEEME.txt b/LEEME.txt
new file mode 100644
index 0000000..68b1a16
--- /dev/null
+++ b/LEEME.txt
@@ -0,0 +1,40 @@
+ ####################################################
+#   ____ ___  __  __ _____ _   _ _____    _    ____  # 
+#  / ___/ _ \|  \/  | ____| \ | |_   _|  / \  |  _ \  #
+# | |  | | | | |\/| |  _| |  \| | | |   / _ \ | |_) | #
+# | |__| |_| | |  | | |___| |\  | | |_ / ___ \|  _ <  #
+#  \____\___/|_|  |_|_____|_| \_| |_(_)_/   \_\_| \_\ #
+#                                                    #
+ ####################################################
+
+Coment.ar es un script para insertar texto al final de un
+documento de texto, ya sea markdown, html, txt, lo que sea.
+
+Dado que los servidores tilde/pubnix no tienen servicios que
+recopilen comentarios en las paginas web, se vuelve imposible 
+comentar una pagina para dejar un saludo, una recomendacion o
+lo que sea.
+ Ni hablar en protocolos como gopher o gemini.
+
+coment.ar permite que los usuarios agreguen texto al final
+de un documento de texto que luego es tomado por la pagina web.
+Por ejemplo, un <iframe> de HTML.
+
+
+Funcionamiento:
+	Se ejecuta el programa marcando la variable "usuario" donde 
+	se quiera comentar.
+$ coment.ar usuario
+
+El programa pregunta a QUE archivo queremos agregarle texto, se abre
+el editor por defecto del usuario y al guardarlo, agrega el texto
+al final del archivo que elegimos en la ruta de comentarios de la
+pagna web.
+
+
+El programa esta pensado para formatear texto HTML para	evitar que
+los usuarios se escapen de las etiquetas. Esto permite insertar
+arte ascii sin problema.
+
+	
+
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..4fd34bd
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,9 @@
+ ####################################################
+#   ____ ___  __  __ _____ _   _ _____    _    ____  # 
+#  / ___/ _ \|  \/  | ____| \ | |_   _|  / \  |  _ \  #
+# | |  | | | | |\/| |  _| |  \| | | |   / _ \ | |_) | #
+# | |__| |_| | |  | | |___| |\  | | |_ / ___ \|  _ <  #
+#  \____\___/|_|  |_|_____|_| \_| |_(_)_/   \_\_| \_\ #
+#                                                    #
+ ####################################################
+
diff --git a/coment.ar b/coment.ar
index 4cc4487..0581b0f 100755
--- a/coment.ar
+++ b/coment.ar
@@ -1,41 +1,57 @@
 #!/bin/sh
 
+# Si no hay parametro usuario_destino, devuelve mensaje de error. 
 if [ "1" != "$#" ]; then
     echo 'Número incorrecto de parámetros!!'
     echo 'USO:'
     echo "$0 usuario_destino"
     return 2
 fi
+
+# guarda en la variable "z" el nombre del archivo donde volcara el
+# texto. El programa tiene una ruta prefijada donde se deben encontrar los
+# archivos
+
+
 echo Ingrese el nombre del archivo
 echo en el que quiere comentar
 read z
 destino="$1"
 autor="$USER"
 
+# selecciona editor
 if [ "$EDITOR" == "" ]; then
     EDITOR="nano"
 fi
 
+# crea archivo temporal
 tmpfile=$(mktemp)
 
 $EDITOR "$tmpfile"
 
+# si el archivo esta vacio, aborta el proceso.
 if [ ! -s "$tmpfile" ]; then
     echo "El archivo esta vació, abortando."
     rm "$tmpfile"
     return 1
 fi
-
+# Formato de fecha Año/mes/dia
 date=$(date +"%Y-%m-%d")
 
 {
+# agrega una barra divisoria, la fecha y el nombre del autor
     printf '<hr/>\n<p>%s - <strong>%s</strong>:</p>\n' "$date" "$autor"
+# Etiqueta de <pre>, donde ira nuestro texto
     printf '<pre>'
+# vuelca el texto
     cat "$tmpfile" |
+# cambia &, <,> por codigos para evitar escaparse del html
         sed 's|&|\&amp;|g;s|<|\&lt;|g;s|>|\&gt;|g'
     printf '</pre>\n'
+# vuelca todo al final de un archivo en la pagina del $usuario en su carpeta web en la ruta donde se guardan los comentarios
 } >> /home/$destino/public_html/com/${z}.html
 
+# borra el temporal
 rm "$tmpfile"
 
 return 0