From 4b8ea3361a7044b393e5f9819003659e85e120ea Mon Sep 17 00:00:00 2001 From: psycep Date: Wed, 22 Apr 2026 12:03:47 -0500 Subject: [PATCH] docs: show --target flag in README Installation section The Platform Support table already described the three build targets but the Installation block still only showed the default invocation. A reader could see that a windows target existed without knowing how to actually build it. Adds example --target invocations for portable, windows, and all, and softens the dependency paragraph since GCC and libpcap are only required for the native target. --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 86c2878..b7f3aa0 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,29 @@ A complete Go implementation of [Impacket](https://github.com/fortra/impacket) - git clone https://github.com/mandiant/gopacket cd gopacket -# Build and install all tools as gopacket- on your PATH +# Default: Linux/macOS build + install to /usr/local/bin ./install.sh -# Or just build without installing +# Run with no flags and it prompts you through the choices interactively. +# Or pick a target directly: +./install.sh --target portable # static Linux binaries in ./dist/portable/ +./install.sh --target windows # Windows .exe cross-compiles in ./dist/windows/ +./install.sh --target all # build every target in one run + +# Build without installing (native only) ./install.sh --build-only # Or build with make make build ``` -Requires Go 1.24.13+, GCC, and libpcap development headers -(install with `apt install build-essential libpcap-dev` on Debian/Ubuntu/Kali, -or `yum install gcc libpcap-devel` on RHEL/CentOS, or `brew install libpcap` on macOS). - -The libpcap headers are only needed by the `sniff` and `split` tools - if -libpcap is missing, `install.sh` will skip those two and build the rest. +The default (`--target native`) build needs Go 1.24.13+, GCC, and libpcap +development headers (`apt install build-essential libpcap-dev` on +Debian/Ubuntu/Kali, `yum install gcc libpcap-devel` on RHEL/CentOS, or +`brew install libpcap` on macOS). The `portable` and `windows` targets only +need the Go toolchain; `sniff` and `split` become stubs in those builds +because they require libpcap. See [Platform Support](#platform-support) for +the full matrix. ### Platform Support