Skip to content

Commit 3c1f5c3

Browse files
author
Noah Meyerhans
committed
Merge pr #41
2 parents 433f262 + c4151ff commit 3c1f5c3

File tree

7 files changed

+8
-445
lines changed

7 files changed

+8
-445
lines changed

Makefile

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,12 @@
1111
# express or implied. See the License for the specific language governing
1212
# permissions and limitations under the License.
1313

14-
SUBDIRS:=cmd/firectl
15-
1614
# Set this to pass additional commandline flags to the go compiler, e.g. "make test EXTRAGOARGS=-v"
1715
EXTRAGOARGS:=
1816

1917
all: build
2018

2119
generate build clean test:
2220
go $@ $(EXTRAGOARGS)
23-
for d in $(SUBDIRS); do \
24-
cd $$d && go $@ $(EXTRAGOARGS); \
25-
done
2621

2722
.PHONY: all generate clean build test

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
A basic Go interface to the Firecracker API
22
====
33

4-
This package is a Go library to interact with the Firecracker API. There is
5-
also a command-line application that can be used to control Firecracker microVMs
6-
called `firectl`.
4+
This package is a Go library to interact with the Firecracker API. It
5+
is designed as an abstraction of the OpenAPI-generated client that
6+
allows for convenient manipulation of Firecracker VM from Go programs.
77

8-
There are some Firecracker features that are not yet supported by the SDK.
9-
These are tracked as GitHub issues with the
8+
There are some Firecracker features that are not yet supported by the
9+
SDK. These are tracked as GitHub issues with the
1010
[firecracker-feature](https://github.com/firecracker-microvm/firecracker-go-sdk/issues?q=is%3Aissue+is%3Aopen+label%3Afirecracker-feature)
1111
label . Contributions to address missing features are welcomed.
1212

@@ -25,8 +25,9 @@ additional flags to the Go compiler via the `EXTRAGOARGS` make variable.
2525
Tools
2626
---
2727

28-
There's a [firectl](cmd/firectl) tool that provides a simple command-line
29-
interface to launching a firecracker VM.
28+
There's a [firectl](https://github.com/firecracker-microvm/firectl/)
29+
tool that provides a simple command-line interface to launching a
30+
firecracker VM. It also serves as an example client of this SDK.
3031

3132
Network configuration
3233
---

cmd/firectl/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

cmd/firectl/README.md

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

0 commit comments

Comments
 (0)