aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemse2013-07-26 01:32:44 +0200
committerGravatar Tom Willemse2013-07-26 01:32:44 +0200
commit858d79e61b5947edb8f5a2adabe72f3d6340a885 (patch)
tree7b1ef1072e76846cb340196de3e200463006d890
parent171916c8020c225611b8d13e6453dcf0e6940787 (diff)
downloadscrumli-858d79e61b5947edb8f5a2adabe72f3d6340a885.tar.gz
scrumli-858d79e61b5947edb8f5a2adabe72f3d6340a885.zip
Add README and site
-rw-r--r--README.org49
-rw-r--r--site/index.org7
2 files changed, 56 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..cc365e3
--- /dev/null
+++ b/README.org
@@ -0,0 +1,49 @@
+#+STARTUP: showall
+
+* Scrumli
+
+ I know next to nothing about scrum. I know only that I want to stay
+ away from it as much as I can. So here I am writing a project to
+ help us (eventually) scrum.
+
+* Requirements
+
+ It ...
+
+ - ... is written in Common Lisp. Specifically it is written for ~sbcl~.
+ - ... uses Mozilla Persona for authentication and ~drakma~ to
+ communicate with Mozilla Persona.
+ - ... uses Gravatar for avatars and ~md5~ to get the Gravatar avatars
+ - ... uses the ~restas~ web framework.
+ - ... uses PostgreSQL as a database and ~postmodern~ to talk to
+ the database.
+ - ... uses ~cl-json~ to generate JSON
+ - ... uses ~closure-template~ for the few templates it has.
+ - ... uses bootstrap for layout.
+ - ... uses jQuery for some of the JavaScript functionality.
+ - ... uses Font Awesome for icons.
+ - ... and uses React for the UI.
+
+ In other words you need to have the following software installed:
+
+ - [[http://sbcl.org][SBCL]]
+ - [[http://postgresql.org][PostgreSQL]]
+
+ And the following Common Lisp packages:
+
+ - ~drakma~
+ - ~md5~
+ - ~restas~
+ - ~postmodern~
+ - ~cl-json~
+ - ~closure-template~
+
+ ... which should all be available through [[http://quicklisp.org][Quicklisp]]. And the
+ following JavaScript and/or CSS frameworks and libraries are pulled
+ from CDN's by default, but may be customized to load from anywhere
+ you wish:
+
+ - [[http://twitter.github.io/bootstrap][Bootstrap]]
+ - [[http://jquery.com][jQuery]]
+ - [[http://fontawesome.io][Font Awesome]]
+ - [[http://facebook.github.io/react][React]]
diff --git a/site/index.org b/site/index.org
new file mode 100644
index 0000000..236a783
--- /dev/null
+++ b/site/index.org
@@ -0,0 +1,7 @@
+#+TITLE: Scrumli
+#+LINK_HOME: http://ryuslash.org
+#+OPTIONS: num:nil toc:nil author:nil
+#+STARTUP: showall
+#+STYLE: <link rel="stylesheet" type="text/css" href="http://ryuslash.org/org.css" />
+
+#+INCLUDE: "../README.org"