Add README.md.

This commit is contained in:
2025-12-10 20:48:43 +01:00
parent b27a5d68e1
commit d8c4ad29d4

20
README.md Normal file
View File

@@ -0,0 +1,20 @@
# Go Application Versioning
This repository contains a simple Go application that demonstrates how to embedded version strings that come from Git tags during the build process.
The `version.go` source contains a variable named `Version` that is initialized in the code to `undefined` string constant.
The build command replaces this values with Git tag value optionally suffixed with information about changes since the tag.
The build command uses the `-ldflags` option of the `go build` command to set the value of the `Version` variable at compile time.
```go
go build -o testver -ldflags "-X main.Version=$(VERSION)"
```
The version is captured using the following command:
```shell
VERSION=$(git describe --tags --always)
```
Use `make` command to build the application.