update readme

Makefile

@@ -29,10 +29,10 @@ docker_run_image_dot = $(docker_run_image) dot
 
 .PHONY: help
 help:
-	@echo "Ally's skill tree"
+	@echo "Ally's skills tree"
 	@echo ""
 	@echo "subcommands:"
-	@echo "  $(GREEN)lint$(RESET)   runs $(WHITE)yamllint$(RESET) for workflow files $(LIGHTPURPLE)local only$(RESET)"
+	@echo "  $(GREEN)lint$(RESET)   runs $(WHITE)yamllint$(RESET) for workflow files $(LIGHTPURPLE)(local only)$(RESET)"
 	@echo "  $(GREEN)image$(RESET)  builds a docker image (basically $(WHITE)dot$(RESET) with custom font)"
 	@echo "  $(GREEN)build$(RESET)  builds skills tree assets"
 
@@ -47,7 +47,7 @@ build: clean dot png svg pdf
 	@echo "$(WHITE)$(shell date +"%d/%m/%Y %H:%M:%S")$(RESET) $(GREEN)done!$(RESET)"
 
 clean:
-	@find "$(shell pwd)/build" -type f -not -name '.gitkeep' -delete
+	@find "$(shell pwd)/build" -type f -not -name '.gitkeep' -not -name 'README.md' -delete
 
 dot:
 	@bash skills.sh

README.md

@@ -1,10 +1,10 @@
 # Skills
 
-My skill tree.
+My skills tree.
 
 ```text
 $ make
-Ally's skill tree
+Ally's skills tree
 
 subcommands:
   lint   runs yamllint for workflow files local only
@@ -19,7 +19,18 @@ make image
 make build
 ```
 
-The `build` uses `envsubst` in `skills.sh` with `skills.tmpl` to make a `skills.dot` that is generated and then various assets are built from the source file.
+---
+
+The `make image` creates an image which is basically has `graphviz` but with a custom font installed.
+
+The `make build` uses the above image and:
+
+* uses `envsubst`
+* from `skills.sh`
+* to interpolate variables in `skills.tmpl.dot`
+* to make a `skills.dot` source file
+
+the source file is then used to build various assets files in `build/`.
 
 ## Release
 
@@ -37,6 +48,12 @@ git tag 1.0.0 -m 'skills tree released'
 git push origin 1.0.0
 ```
 
+The following variables should be added to the repository's actions secrets:
+
+* `AWS_ACCESS_KEY_ID` - self-explanatory
+* `AWS_SECRET_ACCESS_KEY` - self-explanatory
+* `AWS_S3_BUCKET` - i.e. part before region.aws
+
 ## Example
 
 ![skills](https://static.ac93.uk/resume/skills.png)

build/README.md

@@ -0,0 +1 @@
+This folder is where assets are generated and uploaded to S3 from.