diff --git a/README.md b/README.md index 6f6b6fb..409adf5 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,35 @@ This will create a container called `fedora-toolbox-`. ⬢[user@toolbox ~]$ ``` +## Dependencies and Installation + +Toolbox requires at least Podman 1.4.0 to work, and uses the Meson build +system. + +The following dependencies are required to build it: +- meson +- go-md2man +- systemd + +The following dependencies enable various optional features: +- bash-completion + +It can be built and installed as any other typical Meson-based project: +``` +[user@hostname toolbox]$ meson -Dprofile_dir=/etc/profile.d builddir +[user@hostname toolbox]$ ninja -C builddir +[user@hostname toolbox]$ sudo ninja -C install +``` + +Toolbox is written in Go. Consult the +[src/go.mod](https://github.com/containers/toolbox/blob/master/src/go.mod) file +for a full list of all the Go dependencies. + +By default, Toolbox uses Go modules and all the required Go packages are +automatically downloaded as part of the build. There's no need to worry about +the Go dependencies, unless the build environment doesn't have network access +or any such peculiarities. + ## Goals and Use Cases ### High Level Goals