Skip to content

Commit ae99294

Browse files
committed
Removed examples. Updated README. Fixed the build
1 parent 8e538c2 commit ae99294

File tree

25 files changed

+15
-2133
lines changed

25 files changed

+15
-2133
lines changed

.travis.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ go:
66
env:
77
- GO111MODULE=on
88

9-
before_install:
10-
- go get golang.org/x/lint/golint
11-
129
script:
1310
- make all
1411

Makefile

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,20 @@
11
BUILD=go build
22
CLEAN=go clean
3-
INSTALL=go install
43
BUILDPATH=./_build
4+
GO111MODULE=on
55
PACKAGES=$(shell go list ./... | grep -v /examples/)
6-
EXAMPLES=$(shell find examples/* -maxdepth 0 -type d -exec basename {} \;)
7-
8-
examples: builddir
9-
for example in $(EXAMPLES); do \
10-
go build -o "$(BUILDPATH)/$$example" "examples/$$example/$$example.go"; \
11-
done
126

137
all: dep check test
148

159
builddir:
1610
mkdir -p $(BUILDPATH)
1711

18-
install:
19-
$(INSTALL) ./$(EXDIR)/...
20-
2112
clean:
2213
rm -rf $(BUILDPATH)
2314
go clean
2415

2516
dep:
26-
go get ./...
17+
go get
2718

2819
check:
2920
go vet ./...
@@ -33,4 +24,4 @@ test:
3324
go test -coverprofile="../../../$$pkg/coverage.txt" -covermode=atomic $$pkg || exit; \
3425
done
3526

36-
.PHONY: clean examples
27+
.PHONY: clean

README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ In addition it provides an implementation of [Rauch–Tung–Striebel](https://e
1818

1919
# Get started
2020

21-
You might want to Install [GoCV](https://gocv.io) as instructed [here](https://github.com/hybridgroup/gocv/#how-to-install).
22-
2321
Get the package:
2422
```shell
2523
$ go get github.com/milosgajdos83/go-estimate
@@ -34,30 +32,7 @@ Run unit tests:
3432
```shell
3533
$ make test
3634
```
37-
38-
# Examples
39-
40-
The project provides a few [example](examples) programs which demonstrate basic usage of the `go-estimate` packages.
41-
42-
You can build the examples by running the following command:
43-
```shell
44-
$ make examples
45-
```
46-
47-
This will create a directory called `_build` in your current working directory and places the newly built binaries into it. You can now run the programs by executing any of the binaries from the `_build` directory.
48-
49-
Alternatively, you can also install the examples by either running `go install` for each of the examples or do it all with one command:
50-
```shell
51-
$ make install
52-
```
53-
54-
Most of the examples are static i.e. they generate a plot which shows how filter estimates new values from the noise measurements.
55-
56-
There are however [two](examples/bfgocv) [examples](examples/kfgocv) which use the wonderful [gocv](https://gocv.io/). They allow you to watch the filter live in action.
57-
58-
Example of bootstrap filter in action:
59-
60-
<img src="./examples/bfgocv/bootstrap_filter.gif" alt="Bootstrap filter in action" width="200">
35+
You can find various examples of usage in [go-estimate-examples](https://github.com/milosgajdos83/go-estimate-examples).
6136

6237
# TODO
6338

examples/bf/bf.go

Lines changed: 0 additions & 149 deletions
This file was deleted.

examples/bf/system.png

-20 KB
Binary file not shown.

0 commit comments

Comments
 (0)