Skip to content

Add build instructions #1648

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

Add build instructions #1648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 32 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,6 @@ When writing a suggestion:

# First Contribution

Toolbx is written in [Go](https://golang.org) and uses [Meson](https://mesonbuild.com)
as it's buildsystem.

Instructions for building Toolbx from source are in our [README](https://github.com/containers/toolbox/blob/main/README.md).

> You may not need to build the project from source if your contribution is not
> related to the code of Toolbx itself (e.g., documentation, updating CI
> config, playing with image definitions,...).

Here are some ideas of what you could contribute with:

- Check our [bug tracker](https://github.com/containers/toolbox/issues)
Expand All @@ -102,6 +93,38 @@ Here are some ideas of what you could contribute with:
Toolbx currently does not have an infrastructure for translations. You can help
us to set it up!

# Building

Toolbx is written in [Go](https://golang.org) and uses [Meson](https://mesonbuild.com)
as it's buildsystem.

> Note: You may not need to build the project from source if your contribution is not
> related to the code of Toolbx itself (e.g., documentation, updating CI
> config, playing with image definitions,...).

## Install Prerequisites
- Fedora:
```bash
sudo dnf install gcc meson patchelf shadow-utils-subid-devel golang golang-github-cpuguy83-md2man bats podman skopeo
```
- Arch:
```bash
sudo pacman -S base-devel meson shadow go go-md2man bats podman skopeo
```
- Ubuntu:
```bash
sudo apt install build-essential meson patchelf libsubid-dev golang go-md2man bats podman skopeo
```

## Run Meson
Clone the repository and `cd` into it. Then:
```bash
meson setup builddir
cd builddir
meson test # run golang tests
meson compile # compiled artifacts will be in builddir/src
```

# Pull Requests

All pull requests are welcome! Features, bug fixes, fixing of typos, tests,
Expand Down