summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2010-12-01 13:54:22 -0700
committerBen Beltran <ben@nsovocal.com>2010-12-01 13:54:22 -0700
commit787621c343b12bbbb0922cc1faf4cdcaa5f4c245 (patch)
tree803bb4ef3c05902ef0bfe5a772141af3ceee86c8 /README.markdown
parenta847ac2f16eab830b4421a4a9643cb9ee58b30ae (diff)
Agregué el README
Un archivo markdown con la info básica del proyecto (para github)
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown47
1 files changed, 47 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..ad65927
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,47 @@
+#Grita
+
+Grita es un app sencillo hecho con Sinatra que almacena texto en formato markdown y genera urls y códigos QR-Code para poder compartirlo. Está diseñado para ejecutarse en heroku.
+
+Para generar las tablas necesarias con DataMappeer, se debe correr irb desde el directorio raiz de la aplicación y correr los siguientes comandos:
+
+ >> require 'grita.rb'
+ >> DataMapper.auto_migrate!
+
+(NOTA: Con Heroku no es necesario importar el archivo grita.rb y solo se corre el último comando)
+
+Para instalar las dependencias se debe correr el siguiente comando:
+
+ $ bundle install
+
+Para correr la aplicación simplemente se debe de correr el siguiente comando:
+
+ $ ruby -rubygems grita.rb
+
+#Licencia
+
+Este trabajo está distribuído bajo la nueva licencia BSD que se muestra a continuación:
+
+ Copyright (c) 2010, Rubén Beltrán del Río
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of the organization nor the
+ names of its contributors may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file