Make it easier to get started

Author: Arxcis

Makefile

@@ -1,4 +1,4 @@
-test-all:
+test.all:
 	for day in $$(ls days); do ./days/$$day/test.sh; done
 
 test:
@@ -7,38 +7,48 @@ test:
 test.example:
 	make test DAY=day-00-example
 
-
-dockerbuild: Dockerfile
-	docker build . --tag jonasjso/adventofcode2020
-
-dockerpush:
-	docker push jonasjso/adventofcode2020:latest
+test.01:
+	make test DAY=day-01
 
 #
-# make dockertest DAY=<day>
+# make docker.test DAY=<day>
 #
 # Run all the tests for a day inside a docker container. Should work out of the box, if you already have docker installed.
 #
-#   Example: make dockertest DAY=day-03
+#   Example: make docker.test DAY=day-03
 #
 # Benefit 1: Avoids having to install all languages on the host machine.
 # Benefit 2: Reproduceability - Makes sure tests run with the same versions on any machine, regardless of what is installed on the host machine.
 #
-dockertest:
+docker.test:
+	docker pull jonasjso/adventofcode2020:latest;
 	docker run -ti --env DAY=$(DAY) -v $(PWD):/test jonasjso/adventofcode2020:latest /bin/bash -c "cd /test && make test && exit"
 
-dockertest.example:
-	make dockertest DAY=day-00-example
+docker.example:
+	make docker.test DAY=day-00-example
 
-#
-# make dockertest-all
-#
-# Run all tests for all days inside a docker container.
-#
-dockertest-all:
+docker.01:
+	make docker.test DAY=day-01
+
+docker.all:
 	docker run -ti -v $(PWD):/test jonasjso/adventofcode2020:latest /bin/bash -c "cd /test && make && exit"
 
+docker.build: Dockerfile
+	docker build . --tag jonasjso/adventofcode2020
+
+docker.push:
+	docker push jonasjso/adventofcode2020:latest
+
 versions:
 	./scripts/print-versions.sh
 
-.PHONY: dockerbuild dockerpush test test-all versions dockertest dockertest-all
+.PHONY:
+	dockerbuild\
+ 	dockerpush\
+	test\
+	test.all\
+	docker.test\
+	docker.all\
+	docker.build\
+	docker.push\
+	versions;\

README.md

@@ -32,3 +32,25 @@ Here you can see the status of automatic tests run by Github CI:
 ![days/day-24](https://github.com/Arxcis/adventofcode2020/workflows/days/day-24/badge.svg)
 ![days/day-25](https://github.com/Arxcis/adventofcode2020/workflows/days/day-25/badge.svg)
 ![days/day-00-example](https://github.com/Arxcis/adventofcode2020/workflows/days/day-00-example/badge.svg)
+
+## Getting started if you are running Docker
+
+If you are running docker, you can run tests inside a docker-container by doing:
+```
+make docker.example         // Expect example tests to succeed
+make docker.01              // Expect fail because we don't have any day-01 tests
+make docker.all             // Expect some tests to succeed, some fail
+```
+
+## Getting started if you are not running Docker
+If you are not running docker, you have to install languages we support on your host system. See the [Dockerfile](./Dockerfile) for how you can do this on debian-based systems. You can run the tests directly on your host system by doing:
+```
+make test.example           // Expect example tests to succeed
+make test.01                // Expect fail because we don't have any day-01 tests
+make test.all               // Expect some tests to succeed, some fail
+```
+
+
+## Demo
+
+[![asciicast](https://asciinema.org/a/82OAZ2P8MLxVvVT568rFEjh0n.svg)](https://asciinema.org/a/82OAZ2P8MLxVvVT568rFEjh0n)