From 7725f46cd64c5a405ffed6177019383ffe18dd8e Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@nordberg.se>
Date: Fri, 4 Apr 2014 15:54:21 +0200
Subject: add build related notes

---
 src/Makefile     | 2 ++
 src/catlfish.erl | 6 ++++++
 2 files changed, 8 insertions(+)

(limited to 'src')

diff --git a/src/Makefile b/src/Makefile
index 0b77c52..9650e25 100644
--- a/src/Makefile
+++ b/src/Makefile
@@ -1,3 +1,5 @@
+## TODO: Consider using 'rebar' instead of Make.
+
 MODULES = catlfish
 
 all: subdirs $(MODULES:%=%.beam)
diff --git a/src/catlfish.erl b/src/catlfish.erl
index cfdec8b..a8c5a86 100644
--- a/src/catlfish.erl
+++ b/src/catlfish.erl
@@ -1,3 +1,9 @@
+%% This is a CA transparency log.
+
+%% In order to find https_server and other required modules, a couple
+%% of subdirectories need to be added to the Erlang path
+%% (code:add_pathz/1). This can be done through an ~/.erlang file.
+
 -module('catlfish').
 -export([start/0]).
 
-- 
cgit v1.1