add INSTALL, README.tmp and TODO, start openbsd-specific makefile

1 files changed, 29 insertions, 0 deletions

diff --git a/README.tmp b/README.tmp
new file mode 100644
index 0000000..11d0f64
--- /dev/null
+++ b/README.tmp
@@ -0,0 +1,29 @@
+this file explains my workflow/structuring habits and is meant only to
+save mentor's time. ideally, this file will be deleted before "release"
+and all files will follow standard protocol/KNF.
+------------------------------------------------------------------------
+FILESYSTEM
+
+/src - source files
+	/src/logind - obvious
+	/src/hostnamed - obvious
+	/src/localed - obvious
+	/src/timedated - obvious
+/bin - dir for compiled test binaries, will eventually be build tmp dir
+/build - build dir
+------------------------------------------------------------------------
+TODO
+
+i keep a general informal list of TODO tasks in /TODO, as well as inline
+TODOs in source. TODO tasks must be single line as the are delimited by
+a newline character, this makes it so one can easily grep for TODO: and
+get complete output. before release, /TODO should be deleted and "TODO:"
+should never appear anywhere in any file.
+
+additionally, any questions for mentors are written as comments and end
+in ajacoutot@ or landry@, i use these if i can't catch y'all on IRC :)
+------------------------------------------------------------------------
+ETC
+
+* make sure to end files newlines as their abscence confuses git
+