Skip to content

Commit b5c82ef

Browse files
committed
chore: add README, update makefile
1 parent 45b87e0 commit b5c82ef

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

Makefile

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
all: lint test coverage check-licenses build
33

44
.PHONY: build
5-
build: cmd1 cmd2
5+
build:
66

77
.PHONY: lint
88
lint: prepare
99
golangci-lint run
1010

1111
.PHONY: prepare
1212
prepare:
13-
go mod vendor
13+
go mod tidy
1414

1515
cmd1 cmd2:
1616
go build -ldflags "-X github.com/Eyevinn/{Name}/internal.commitVersion=$$(git describe --tags HEAD) -X github.com/Eyevinn/{Name}/internal.commitDate=$$(git log -1 --format=%ct)" -o out/$@ ./cmd/$@/main.go
@@ -21,10 +21,7 @@ test: prepare
2121

2222
.PHONY: coverage
2323
coverage:
24-
# Ignore (allow) packages without any tests
25-
set -o pipefail
2624
go test ./... -coverprofile coverage.out
27-
set +o pipefail
2825
go tool cover -html=coverage.out -o coverage.html
2926
go tool cover -func coverage.out -o coverage.txt
3027
tail -1 coverage.txt

readme.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
# {{Name}}
1+
# VMAP
2+
3+
A small library for marshaling and unmarshaling VMAP and VAST.
24

3-
<!--
45

56
## Requirements
6-
Add any external project dependencies such as node.js version etc here
7+
Go version 1.22 or higher
78

89
## Installation / Usage
910

10-
Add clear instructions on how to use the project here
11+
This is a library meant to be downloaded and installed like other Go code.
12+
13+
To enable it in your Go project, run
14+
15+
```go get github.com/Eyevinn/VMAP```
16+
17+
To use the library, add
18+
```import github.com/Eyevinn/VMAP```
1119

1220
## Development
1321

1422
Add clear instructions on how to start development of the project here
1523

16-
-->
17-
18-
### Contributing
1924

20-
See [CONTRIBUTING](CONTRIBUTING.md)
2125

2226
# Support
2327

0 commit comments

Comments
 (0)