summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt36
1 files changed, 36 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..652a1ef
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,36 @@
+=== voting-site ===
+
+This is the source of the website at vote.benjidial.net.
+
+=== dependencies ===
+
+This code is written in Racket and requires a few packages. On Debian, you can
+get all of the dependencies by running the following commands:
+ sudo apt install racket
+ raco pkg install koyo scgi smtp
+
+=== running ===
+
+The server can be run with `racket main.rkt`. This will start a scgi server
+on port 9000. You will need an SCGI-compatible web server. For example, with
+nginx, you can make a server entry with:
+ server {
+ location / {
+ include scgi_params;
+ scgi_pass localhost:9000;
+ }
+ }
+
+=== attribution ===
+
+The files static/CrimsonPro-*.woff2 are from
+ https://github.com/Fonthausen/CrimsonPro
+and are licensed under the Open Font License, version 1.1.
+This license can be found at:
+ https://github.com/Fonthausen/CrimsonPro/blob/master/OFL.txt
+
+The file static/favicon.ico is from
+ https://www.flaticon.com/free-icons/vote
+and is licensed under the Flaticon license.
+This license can be found at:
+ https://www.freepikcompany.com/legal#nav-flaticon