From 4e0e5dab179c83d12774b05a58b9a0e159ee9f6b Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 May 2024 13:52:03 -0400 Subject: [PATCH] update 'requirements' section --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3da74d229..e5748cc3d 100644 --- a/README.md +++ b/README.md @@ -56,19 +56,24 @@ We welcome and appreciate any contributions from our community. Please visit our ## REQUIREMENTS -Build Requirements: -- Git -- JDK v17+ +Build requirements: +- git +- JDK 17+ - Maven v3+ - [Quarkus CLI](https://quarkus.io/guides/cli-tooling) v3.4.1+ (Recommended) - [Podman](https://podman.io/docs/installation) 4.7+ -Run Requirements: +Smoketest run requirements: - [`yq`](https://github.com/mikefarah/yq) v4.35.1+ - [`kompose`](https://kompose.io/installation/) v1.31.2+ - [docker-compose](https://docs.docker.com/compose/install/) v1.29.2 - [podman-docker](https://packages.fedoraproject.org/pkgs/podman/podman-docker/) (Optional) +General run requirements: +- an OpenShift or Kubernetes cluster + - recommended installation methods: [`cryostat-operator`](https://github.com/cryostatio/cryostat-operator) or [`cryostat-helm`](https://github.com/cryostatio/cryostat-helm) +- OR any other container platform which can host OCI containers + ## BUILD This project uses Quarkus, the Supersonic Subatomic Java Framework.