Skip to content

Commit 29117fd

Browse files
tomy0000000claude
andauthored
📖 [docs][docker] README (#100)
## Summary Added a new `docker` package documentation file that describes the installation and configuration of Docker Desktop and Hadolint on macOS. ## Changes - Created `pkg/docker/README.md` with comprehensive package documentation including: - Overview of the package purpose (Docker Desktop and Hadolint installation on macOS) - Installation matrix showing tool availability by platform - Notes on Docker Desktop bundling and Hadolint's linting capabilities - Platform-specific information (macOS only, invoked via `make macos-docker`) ## Details The documentation follows the established package documentation pattern and clearly communicates that this is a macOS-only package with no Debian support. It explains that Docker Desktop is installed as a Homebrew cask while Hadolint is installed as a formula, and notes that Docker Desktop bundles all necessary Docker CLI tools. https://claude.ai/code/session_015enMAVSMtxAVJmkPMSKCFj Co-authored-by: Claude <noreply@anthropic.com>
1 parent d567562 commit 29117fd

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

pkg/docker/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# `docker`
2+
3+
Installs Docker Desktop and Hadolint (Dockerfile linter) on macOS.
4+
5+
## Installs
6+
7+
| Tool | macOS | Debian |
8+
| ---------- | ------ | ------ |
9+
| `docker` | `brew` ||
10+
| `hadolint` | `brew` ||
11+
12+
> Docker Desktop is installed as a cask; `hadolint` is a Homebrew formula.
13+
14+
## Configures
15+
16+
No configuration files are managed by this package.
17+
18+
## Notes
19+
20+
- macOS only — no Debian target exists.
21+
- Invoke via `make macos-docker`.
22+
- Docker Desktop bundles `docker`, `docker compose`, and the Docker daemon; no separate CLI install is needed.
23+
- `hadolint` lints Dockerfiles against best practices and the official Dockerfile reference.

0 commit comments

Comments
 (0)