summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <s@ricketyspace.net>2019-05-24 21:12:45 -0400
committerrsiddharth <s@ricketyspace.net>2019-05-24 21:12:45 -0400
commit96adbf24800cba03d26f3565fc27b78130571c9d (patch)
tree48789f9a70e2fec85f1b850b1dbe458052eb8957
parentfc66fa8831e7f6c9e40c28f793bbdc025ffa014a (diff)
Add README.md.
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5135948
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# FSF India Website
+
+The site is mostly written in plain HTML with server side includes
+(SSI). It uses The [Bulma][bulma] CSS framework for styling.
+
+News and article sections are written in markdown. The `bin/html`
+script generates the HTML and the `bin/feed` script generates the Atom
+feeds for these sections.
+
+The POSTs from 'contact' and 'volunteer' forms are handled by a PHP
+script. At the moment it simply forwards the submission to an email
+address.
+
+[bulma]: https://bulma.io
+
+## Tools
+
+These tools are needed to build the site:
+
+ - make
+ - [sassc][sassc]
+ - python3
+ - perl (`bin/markdown` needs it :|)
+
+[sassc]: https://github.com/sass/sassc
+
+## Building
+
+Just do:
+
+ make