Skip to content

Fix prerequisites in the documentation #34

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
migrym wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Fix prerequisites in the documentation #34

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d18c37a
Fix prerequisites in the documentation
migrym Jul 8, 2026
f266d4f
Clarify nFPM is needed when building packages locally
migrym Jul 8, 2026
cea8798
Control the packages created by docker build with build args
migrym Jul 8, 2026
6365eab
Fix typo, align code example style
migrym Jul 10, 2026
2e383bd
Merge branch 'nokia:main' into fix-prerequisites
migrym Jul 10, 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
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ can be targeted by name when running `corteca exec`.

| Requirement | Version | Notes |
| ----------- | -------- | ---------------------------------------------- |
| Go | ≥ 1.21 | Required to build from source |
| Go | ≥ 1.25 | Required to build from source |
| nFPM | ≥ 2.46 | Required to build packages locally |
| Docker | ≥ 23.0 | Required to build application container images |
| Docker BuildKit | ≥ 0.11 | Required for `docker build --output` |
| make | any | Used to drive the build and install targets |
Expand Down Expand Up @@ -164,13 +165,21 @@ $ DESTDIR=~/.local/share make install

### Install with package manager

If you are using debian/ubuntu or redhat-based distributions, you can create a relevant package and let your package manager handle installation. E.g. for ubuntu:
If you are using debian/ubuntu or redhat-based distributions, you can create a relevant package and let your package manager handle installation (nFPM is required). E.g. for Ubuntu:

```bash
$ make deb
$ make rpm
```

#### Installing nFPM

If an appropriate package is not available for your platform, you can install nFPM with:

```bash
$ go install github.com/goreleaser/nfpm/v2/cmd/nfpm@v2.46.0
```

@migrym migrym Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

A more extensive description on how to get the binary and install it in a directory in your path is probably required

@mptrk mptrk Jul 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

No this is fine; although I would prefer to use the tag latest, as in:

$ go install github.com/goreleaser/nfpm/v2/cmd/nfpm@latest

Also, lets try to follow the convention of using bash as the highlighting schema in fenced code blocks that illustrate command line invocations, and prefix them with $. i.e the above should be written as:

```bash
$ go install github.com/goreleaser/nfpm/v2/cmd/nfpm@latest
```

@migrym migrym Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changing the tag also changes the Go version it requires, I opted to pin the versions in the prerequisites here, though go install works regardless. As for the prompt, I avoid it because pressing the copy button will not copy just the the command part, so you will need to paste and edit before running it.

@migrym migrym Jul 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed to follow the convention throughout the README, but please consider if removing the prompt would better facilitate copy-pasting the code block commands.

Please comment if you still want to opt for the latest nFPM version when installing.


## Getting Started

The fastest way to get up and running is to create a project, build it, and
Expand Down Expand Up @@ -204,8 +213,8 @@ The `corteca config` command can be used to inspect or modify any value
without editing YAML by hand:

```bash
corteca config get publish # show all publish targets
corteca config set app.version 1.1 # update a value
$ corteca config get publish # show all publish targets
$ corteca config set app.version 1.1 # update a value
```

For a full reference of every configuration key, their types, defaults, and
Expand All @@ -229,6 +238,6 @@ For a broader overview of all commands, flags, and usage patterns see
Every command also accepts `--help` for inline usage information:

```bash
corteca --help
corteca build --help
$ corteca --help
$ corteca build --help
```
Loading