From ff8acd493bf46e23a0321282ead6b8d53d070a6a Mon Sep 17 00:00:00 2001
From: Gregory Ballantine <gballan1@umbc.edu>
Date: Thu, 2 Oct 2025 11:22:21 -0400
Subject: [PATCH] [Issue #2] - Added .air.toml for using air with some sane
 defaults; added README to document how to use it (plus some info on the app)

---
 .air.toml | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 106 insertions(+)
 create mode 100644 .air.toml
 create mode 100644 README.md

diff --git a/.air.toml b/.air.toml
new file mode 100644
index 0000000..2f45997
--- /dev/null
+++ b/.air.toml
@@ -0,0 +1,52 @@
+root = "."
+testdata_dir = "testdata"
+tmp_dir = "tmp"
+
+[build]
+  args_bin = []
+  bin = "./tmp/main"
+  cmd = "go build -o ./tmp/main ."
+  delay = 1000
+  exclude_dir = ["assets", "tmp", "vendor", "testdata", "node_modules", "public", "data"]
+  exclude_file = []
+  exclude_regex = ["_test.go"]
+  exclude_unchanged = false
+  follow_symlink = false
+  full_bin = ""
+  include_dir = []
+  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_file = []
+  kill_delay = "0s"
+  log = "build-errors.log"
+  poll = false
+  poll_interval = 0
+  post_cmd = []
+  pre_cmd = []
+  rerun = false
+  rerun_delay = 500
+  send_interrupt = false
+  stop_on_error = false
+
+[color]
+  app = ""
+  build = "yellow"
+  main = "magenta"
+  runner = "green"
+  watcher = "cyan"
+
+[log]
+  main_only = false
+  silent = false
+  time = false
+
+[misc]
+  clean_on_exit = false
+
+[proxy]
+  app_port = 0
+  enabled = false
+  proxy_port = 0
+
+[screen]
+  clear_on_rebuild = false
+  keep_scroll = true
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e1e1453
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Benchmark Logging Tool (BLT)
+
+![Build badge](https://builds.metaunix.net/api/badges/87/status.svg)
+
+Web-based tool to store and organize PC hardware benchmarks.
+
+## Project Goals
+
+The goals of this project are to:
+
+* Record benchmarking results from multiple devices - e.g. log from a laptop or a phone.
+* Group results into tests to keep track of different testing configurations.
+* Encourage running tests multiple times - it's good practice to run a benchmark multiple times for accuracy.
+* Create comparisons of hardware tests to compare performance.
+* Generate graphs of hardware comparisons for usage in videos and articles.
+
+## Requirements
+
+BLT runs on Go. It uses the built-in `go mod` tool to manage dependencies, thus there is no external tooling to install to build/run BLT.
+
+Debian/Ubuntu: `apt install -y golang`
+RedHat and clones: `dnf install -y golang`
+
+## Production Deployment
+
+**TODO**
+
+## Development
+
+### Via Docker
+
+**TODO**
+
+### Local/Native Development
+
+BLT uses [air](https://github.com/air-verse/air) to auto-reload the app. While this is not strictly necessary, it used to make development more convenient. If you wish to forego installing it, you may simply build and run the app with the standard `go run main.go`.
+
+1. Install dependencies:
+
+`go mod download`
+
+2. Install air to auto-reload the app:
+
+`go install github.com/cosmtrek/air@latest`
+
+3. Run the app via air:
+
+`air`
+
+4. If everything is running successfully you can open your browser and go to http://localhost:2830.
+
+## License
+
+This project is available under the BSD 2-Clause license.