diff --git a/.gitignore b/.gitignore index 5772ca3..0e8d217 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .* !.gitignore +!.screenshot.png minipam *.yaml *.json \ No newline at end of file diff --git a/.screenshot.png b/.screenshot.png new file mode 100644 index 0000000..3744c6e Binary files /dev/null and b/.screenshot.png differ diff --git a/README.md b/README.md index 55bd281..917ba58 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,20 @@ there is no authorization mechanism built in. Scanning is kind of slow, but I prefer to keep it that way, since I don't need it to be fast, and I don't want to waste my compute resources. It doesn't matter for me if my scan completes within 1 minute or within 30 minutes. -TODO: screenshot +![Screenshot](.screenshot.png) + +# Compilation + +Install go toolchain and run +```bash +go install git.mlody.eu/lmoskala/MinIPAM +``` +Or, clone repository and run +```bash +go build +``` + +Cross-compiling is as easy as running `GOOS=freebsd GOARCH=amd64 go build`. # Configuration reference ```yaml diff --git a/go.mod b/go.mod index f98507d..bc87434 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module minipam +module git.mlody.eu/lmoskala/MinIPAM go 1.21