Skip to content

Commit 7529f23

Browse files
committed
doc: Update readme
1 parent 1f4d7b1 commit 7529f23

2 files changed

Lines changed: 9 additions & 8 deletions

File tree

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ generate-web: check-go
5959
air: get-deps generate-web
6060
go tool air
6161

62-
## lint: Run golangci-lint to lint go files
62+
## lint: Run golangci-lint to lint Go files
6363
.PHONY: lint
6464
lint:
6565
go run $(GOLANGCI_LINT_PACKAGE) run
6666

67-
## lint-fix: Run golangci-lint to lint go files and fix issues
67+
## lint-fix: Run golangci-lint to lint Go files and fix issues
6868
.PHONY: lint-fix
6969
lint-fix:
7070
go run $(GOLANGCI_LINT_PACKAGE) run --fix
@@ -90,13 +90,13 @@ audit:
9090
tidy: check-go
9191
go mod tidy
9292

93-
## update-deps: Update go dependencies
93+
## update-deps: Update Go dependencies
9494
.PHONY: update-deps
9595
update-deps: check-go
9696
go get -u ./...
9797
-@$(MAKE) tidy
9898

99-
## get-deps: Download go dependencies
99+
## get-deps: Download Go dependencies
100100
.PHONY: get-deps
101101
get-deps: check-go
102102
go mod download

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,17 @@ Commands:
2727
start Build and start application
2828
build-docker Build Docker container image with this app
2929
run-docker Run Docker container image with this app
30+
get-js-deps Install frontend dependencies using bun (locally if available and otherwise via Docker)
3031
test Run unit tests
3132
generate-web Compile templ files via github.com/a-h/templ/cmd/templ
3233
air Build and start application in live reload mode via air
33-
lint Run golangci-lint to lint go files
34-
lint-fix Run golangci-lint to lint go files and fix issues
34+
lint Run golangci-lint to lint Go files
35+
lint-fix Run golangci-lint to lint Go files and fix issues
3536
lint-fmt Run golangci-lint fmt to show code format issues
3637
audit Quality checks
3738
tidy Removes unused dependencies and adds missing ones
38-
update-deps Update go dependencies
39-
get-deps Download go dependencies
39+
update-deps Update Go dependencies
40+
get-deps Download Go dependencies
4041
check-go Check that Go is installed
4142
help Display help
4243
```

0 commit comments

Comments
 (0)