Skip to content

docs: add system requirements section to README #3350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ded-furby wants to merge 7 commits into
base: main
Choose a base branch
from
+14 −1
Open

docs: add system requirements section to README #3350

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
97319e3
docs(cli-3343): add development requirements section
ded-furby Jun 19, 2026
4660705
docs: align podman service commands
ded-furby Jun 19, 2026
c4602e3
docs: restore user Podman service commands
ded-furby Jun 19, 2026
34c03f2
docs: align Podman startup instructions
ded-furby Jun 19, 2026
e1787a7
docs(EC): reference troubleshooting for Podman setup commands
ded-furby Jun 20, 2026
4ed8095
docs(EC): clarify Podman setup reference
ded-furby Jun 21, 2026
bd73ac7
docs(EC): keep Podman user socket command focused
ded-furby Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ such as:
Consult the [documentation][docs] for available sub-commands, descriptions and
examples of use.

## Development Requirements
Comment thread
ded-furby marked this conversation as resolved.

@fullsend-ai-review fullsend-ai-review Bot Jun 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] naming-convention

Section header Development Requirements uses a noun phrase, while some other sections use gerund forms (Building, Testing, Linting). However, existing sections Demo and Troubleshooting are also noun phrases, so the naming style is already inconsistent in the current README.

Suggested fix: Consider renaming to Prerequisites for brevity, but this is purely stylistic and the existing README already mixes naming conventions.


Before building or testing `ec`, install the following tools:

- Go 1.25.8+ (matching `go.mod`)
Comment thread
ded-furby marked this conversation as resolved.
- Make
- Podman or Docker (for acceptance tests and container-based workflows)
- Node.js 18+ (for `tekton-lint`)

Comment thread
ded-furby marked this conversation as resolved.
On Fedora/RHEL systems, acceptance tests often require Podman to run as a user service.
Use the troubleshooting section below for the required Podman service commands, and
then run the appropriate Building or Testing commands.

## Building

Run `make build` from the root directory and use the `dist/ec` executable, or
Expand Down Expand Up @@ -78,7 +91,7 @@ It is advised to do a reboot afterwards.
To start Podman for the user:

``` bash
$ systemctl enable --user --now podman.socket podman.service
$ systemctl enable --user --now podman.socket
```

#### **2.2. Get localhost:37837: connection reset by peer**
Expand Down
Loading