Commit 23d00ba

mo khan <mo@mokhan.ca>
2025-04-11 17:38:45
docs: update README instructions to use make
1 parent 0f18f88
Changed files (2)
Makefile
@@ -2,30 +2,33 @@ PROJECT_NAME := $(shell basename $(shell pwd))
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD | sed 's/\//_/g')
 IMAGE_TAG := $(PROJECT_NAME):$(GIT_BRANCH)
 
-.PHONY: build-test-image integration-test
+.PHONY: clean setup build test run
 
 sparkled:
-	go build -o sparkled ./cmd/sparkled/main.go
+	@go build -o sparkled ./cmd/sparkled/main.go
 
 clean:
-	rm -f sparkled
+	@rm -f sparkled
+
+setup:
+	@mise install
 
 build: sparkled
 
 test:
-	go test ./...
+	@go test ./...
 
 build-image:
-	docker build --tag $(IMAGE_TAG) .
+	@docker build --tag $(IMAGE_TAG) .
 
 build-builder-image:
-	docker build --target build --tag $(IMAGE_TAG) .
+	@docker build --target build --tag $(IMAGE_TAG) .
 
 run: build
 	BIND_ADDR=:8080 ./sparkled
 
 run-image: build-image
-	docker run -it $(IMAGE_TAG)
+	@docker run -it $(IMAGE_TAG)
 
 sh-image: build-builder-image
-	docker run -it $(IMAGE_TAG) /bin/sh
+	@docker run -it $(IMAGE_TAG) /bin/sh
README.md
@@ -32,6 +32,6 @@ The Authorization team is researching ways to evolve GitLab's authorization stac
 ## Getting Started
 
 ```bash
-mise install
-go run ./cmd/sparkled/main.go
+make setup
+make run
 ```