document this project #2

New issue

Open

opened 2026-05-05 12:55:48 +00:00 by thabeta · 1 comment

thabeta commented

2026-05-05 12:55:48 +00:00

Owner

No description provided.

thabeta commented

2026-05-05 14:11:03 +00:00

Author

Owner

Implementation Plan

The following documentation files will be added to close this issue:

SPEC.md

Architectural specification covering:

Project overview (ncgo module, Go 1.21+)
Complete CLI flag table with short flags, types, defaults
Module layout with file descriptions
Key function signatures from all source files (main.go, cmd/connect.go, ncnet/resolve.go, ncnet/connection.go, util/hexdump.go, util/timeout.go)
Configuration section (command-line only, no external files)
Error handling table per component
Signal handling (SIGINT/SIGTERM)
Testing reference

README.md

User-facing documentation including:

Feature list
Installation instructions (build from source / go install)
Usage examples for connect mode and listen mode
Complete options reference table
Practical examples (port scanning, file transfer, UDP echo, hex dump debugging)
Project structure diagram
Testing command (go test ./...)

Implementation Steps

Create SPEC.md with full architectural documentation
Create README.md with user-facing documentation
Run go build ./... to verify the project still compiles
Run go test ./... to verify all tests pass
Commit both files

Acceptance Criteria

README.md exists, is non-empty, and contains install/build instructions
SPEC.md exists, is non-empty, and documents all modules and CLI flags
go build ./... succeeds
go test ./... succeeds
Both files are committed to the repository

Please review and approve so I can proceed with implementation.

## Implementation Plan The following documentation files will be added to close this issue: ### SPEC.md Architectural specification covering: - Project overview (`ncgo` module, Go 1.21+) - Complete CLI flag table with short flags, types, defaults - Module layout with file descriptions - Key function signatures from all source files (`main.go`, `cmd/connect.go`, `ncnet/resolve.go`, `ncnet/connection.go`, `util/hexdump.go`, `util/timeout.go`) - Configuration section (command-line only, no external files) - Error handling table per component - Signal handling (`SIGINT`/`SIGTERM`) - Testing reference ### README.md User-facing documentation including: - Feature list - Installation instructions (build from source / `go install`) - Usage examples for connect mode and listen mode - Complete options reference table - Practical examples (port scanning, file transfer, UDP echo, hex dump debugging) - Project structure diagram - Testing command (`go test ./...`) ### Implementation Steps 1. Create `SPEC.md` with full architectural documentation 2. Create `README.md` with user-facing documentation 3. Run `go build ./...` to verify the project still compiles 4. Run `go test ./...` to verify all tests pass 5. Commit both files ### Acceptance Criteria - [ ] `README.md` exists, is non-empty, and contains install/build instructions - [ ] `SPEC.md` exists, is non-empty, and documents all modules and CLI flags - [ ] `go build ./...` succeeds - [ ] `go test ./...` succeeds - [ ] Both files are committed to the repository Please review and approve so I can proceed with implementation.