Commit 8cf2127
Changed files (1)
README.md
@@ -0,0 +1,33 @@
+Testing Engine
+===============
+
+This application allows a user to establish a testing engine that reads from `csv` files and serves
+them to the client.
+
+## Starting the Application
+
+Compile the server with `go install questioner.go question.go structures.go` and run it by
+`$GOBIN/questioner -f /path/to/config/file`. The default configuration for the server is
+
+```
+LISTEN_ADDRESS = "127.0.0.1"
+LISTEN_PORT = 80
+PERMIT_BLANK_PASSWORD = true
+USE_HTTPS = false
+PRIVATE_KEY = "~/.ssh/question.priv"
+QUESTIONS = "/path/to/questions"
+```
+
+Compile the client with `go install client.go structures.go command.go` and run it by
+`$GOBIN/client --file /path/to/config/file`. The default configuration for the client is
+
+```
+SERVER = "127.0.0.1"
+PORT = 80
+USE_HTTPS = false
+```
+
+## CSV Format
+The `csv` files should consist of the fields `question,response,category`. The application reads
+the questions from either a file or recursively from a directory; the behavior depends on the option
+passed under `QUESTIONS` in the `conf` file.