Skip to content

Commit

Permalink
Declare this as a published module supporting hamlib v4
Browse files Browse the repository at this point in the history
When dh1tw#12 gets resolved, this fork will be obsolete.
  • Loading branch information
xylo04 committed Jul 25, 2022
1 parent 507132a commit 14171a3
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
*.swp
*.out
settings.json

.idea/
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
**This (hopefully temporary) fork supports Hamlib v4.**

# Hamlib binding for Golang
[![Go Report Card](https://goreportcard.com/badge/github.com/dh1tw/goHamlib)](https://goreportcard.com/report/github.com/dh1tw/goHamlib)
[![Build Status](https://travis-ci.org/dh1tw/goHamlib.svg?branch=master)](https://travis-ci.org/dh1tw/goHamlib)
[![Coverage Status](https://coveralls.io/repos/github/dh1tw/goHamlib/badge.svg?branch=master)](https://coveralls.io/github/dh1tw/goHamlib?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/xylo04/goHamlib)](https://goreportcard.com/report/github.com/xylo04/goHamlib)
[![Build Status](https://travis-ci.org/xylo04/goHamlib.svg?branch=master)](https://travis-ci.org/xylo04/goHamlib)
[![Coverage Status](https://coveralls.io/repos/github/xylo04/goHamlib/badge.svg?branch=master)](https://coveralls.io/github/xylo04/goHamlib?branch=master)

This is a [golang](https://golang.org) binding for
[Hamlib](http://hamlib.org). The binding has been hand written in order
to provide a golang idiomatic API but staying also close as possible to
[hamlib's C API](http://hamlib.sourceforge.net/manuals/3.0.1/index.html).
Except of Hamlib (C), goHamlib has no other external dependencies.

goHamlib is compatible with both, Hamlib 1.2.x and 3.x.
goHamlib is compatible with both, Hamlib 4.x.

You might also want to checkout [gorigctl](https://github.com/dh1tw/gorigctl)
which is a drop-in replacement for hamlib's rigctl, although it comes with a
Expand Down Expand Up @@ -69,7 +71,7 @@ $ brew install hamlib
### Compilation

```bash
$ go get github.com/dh1tw/goHamlib
$ go get github.com/xylo04/goHamlib
```

## Tests
Expand All @@ -78,15 +80,15 @@ Most of goHamlib's API is unit tested. In order to execute the unit tests,
run:

```bash
$ cd $GOPATH/src/github.com/dh1tw/goHamlib
$ cd $GOPATH/src/github.com/xylo04/goHamlib
$ go test
```

## Documentation

goHamlib's API is documented at [go.dev](https://pkg.go.dev/github.com/dh1tw/goHamlib)
goHamlib's API is documented at [go.dev](https://pkg.go.dev/github.com/xylo04/goHamlib)

## Example

Checkout the [dummyrig_test.go](https://github.com/dh1tw/goHamlib/blob/master/dummyrig_test.go) in this
Checkout the [dummyrig_test.go](https://github.com/xylo04/goHamlib/blob/master/dummyrig_test.go) in this
repository to see how to use goHamlib.
2 changes: 1 addition & 1 deletion dummyrig_test.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package goHamlib_test

import (
"github.com/dh1tw/goHamlib"
"github.com/xylo04/goHamlib"
"reflect"
"testing"
)
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/dh1tw/goHamlib
module github.com/xylo04/goHamlib

go 1.14
2 changes: 1 addition & 1 deletion goHamlib_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package goHamlib_test
import (
"testing"

"github.com/dh1tw/goHamlib"
"github.com/xylo04/goHamlib"
)

// Test consistency of Vfo Value and Name maps
Expand Down

0 comments on commit 14171a3

Please sign in to comment.