Skip to content

Commit

Permalink
chore: add README, update makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
Lunkers committed Feb 14, 2025
1 parent 45b87e0 commit b5c82ef
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
7 changes: 2 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
all: lint test coverage check-licenses build

.PHONY: build
build: cmd1 cmd2
build:

.PHONY: lint
lint: prepare
golangci-lint run

.PHONY: prepare
prepare:
go mod vendor
go mod tidy

cmd1 cmd2:
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
Expand All @@ -21,10 +21,7 @@ test: prepare

.PHONY: coverage
coverage:
# Ignore (allow) packages without any tests
set -o pipefail
go test ./... -coverprofile coverage.out
set +o pipefail
go tool cover -html=coverage.out -o coverage.html
go tool cover -func coverage.out -o coverage.txt
tail -1 coverage.txt
Expand Down
20 changes: 12 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# {{Name}}
# VMAP

A small library for marshaling and unmarshaling VMAP and VAST.

<!--

## Requirements
Add any external project dependencies such as node.js version etc here
Go version 1.22 or higher

## Installation / Usage

Add clear instructions on how to use the project here
This is a library meant to be downloaded and installed like other Go code.

To enable it in your Go project, run

```go get github.com/Eyevinn/VMAP```

To use the library, add
```import github.com/Eyevinn/VMAP```

## Development

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

-->

### Contributing

See [CONTRIBUTING](CONTRIBUTING.md)

# Support

Expand Down

0 comments on commit b5c82ef

Please sign in to comment.