Skip to content

Commit e765578

Browse files
committed
format readme
1 parent 4e7b2b2 commit e765578

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

GO_EXAMPLE.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ For `dis-design-system-go` to work correctly, we use `go-bindata` to generate a
2424

2525
Update the frontend service's `Makefile` with the following new commands so that `go-bindata` will generate this file:
2626

27+
P.S. Ignore the empty comments in the makefile examples - they are there to make github happy
28+
2729
```Makefile
2830
LOCAL_RENDERER_IN_USE = $(shell grep -c "\"github.com/ONSdigital/dis-design-system-go\" =" go.mod)
29-
31+
#
3032
.PHONY: fetch-renderer
3133
fetch-renderer:
3234
ifeq ($(LOCAL_RENDERER_IN_USE), 1)
@@ -35,13 +37,13 @@ else
3537
$(eval APP_RENDERER_VERSION=$(shell grep "github.com/ONSdigital/dis-design-system-go" go.mod | cut -d ' ' -f2 ))
3638
$(eval CORE_ASSETS_PATH = $(shell go get github.com/ONSdigital/dis-design-system-go@$(APP_RENDERER_VERSION) && go list -f '{{.Dir}}' -m github.com/ONSdigital/dis-design-system-go))
3739
endif
38-
40+
#
3941
.PHONY: generate-debug
4042
generate-debug: fetch-renderer
4143
cd assets; go run github.com/kevinburke/go-bindata/go-bindata -prefix $(CORE_ASSETS_PATH)/assets -debug -o data.go -pkg assets locales/... templates/... $(CORE_ASSETS_PATH)/assets/locales/... $(CORE_ASSETS_PATH)/assets/templates/...
4244
{ echo "// +build debug\n"; cat assets/data.go; } > assets/debug.go.new
4345
mv assets/debug.go.new assets/data.go
44-
46+
#
4547
.PHONY: generate-prod
4648
generate-prod: fetch-renderer
4749
cd assets; go run github.com/kevinburke/go-bindata/go-bindata -prefix $(CORE_ASSETS_PATH)/assets -o data.go -pkg assets locales/... templates/... $(CORE_ASSETS_PATH)/assets/locales/... $(CORE_ASSETS_PATH)/assets/templates/...
@@ -56,7 +58,7 @@ The `build` and `debug` tasks should use the relevant `generate-` command as a p
5658
```Makefile
5759
.PHONY: build
5860
build: generate-prod
59-
61+
#
6062
.PHONY: debug
6163
debug: generate-debug
6264
```

0 commit comments

Comments
 (0)