From e176398f41927dbfe1ebe22139ad690d1e3da287 Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Wed, 20 Sep 2023 20:09:28 -0600 Subject: [PATCH] Updated README with development instructions --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d514f0..e142e1b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # colossus -Self-hosted database for organizing PC hardware benchmarking results \ No newline at end of file +Self-hosted database for organizing PC hardware benchmarking results. + +## 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 - 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. + +## Development + +The recommended way to run the development server for Colossus is using [Docker](https://docker.com/). + +There are some shell and batch scripts in `bin/` to build and run the containers. To build the containers: + +`bin/docker-build.sh` or `bin/docker-build.bat` + +And then to run the containers: + +`bin/docker-run.sh` or `bin/docker-run.bat` + +This will build the containers for Apache and Grunt to serve the web pages and build front-end assets, respectively. If everything is running successfully you can open your browser and go to https://localhost:8080.