From 0c50671b0937f281778543297f0d09d59f6addbb Mon Sep 17 00:00:00 2001 From: pawloch00 Date: Thu, 19 Dec 2024 14:57:08 +0100 Subject: [PATCH] Clarify Readme section (#302) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add missing used installed tools Signed-off-by: Piotr Pawłowski * prerequistes Signed-off-by: Piotr Pawłowski * readme fixes Signed-off-by: Piotr Pawłowski --------- Signed-off-by: Piotr Pawłowski --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fae90d88..be523845 100644 --- a/README.md +++ b/README.md @@ -65,14 +65,25 @@ and the following CPU types: # Prerequisites -xpk uses many tool to provide all neccessary functionalities. User must install following tools: +Following tools must be installed: - python >= 3.10 (download from [here](https://www.python.org/downloads/)) - gcloud (install from [here](https://cloud.google.com/sdk/gcloud#download_and_install_the)) +- go ([installation instructions](https://go.dev/doc/install)) +- docker ([installation instruction](https://docs.docker.com/engine/install/)) +- pip ([installation instruction](https://pip.pypa.io/en/stable/installation/)) +- python venv ([installation instruction](https://virtualenv.pypa.io/en/latest/installation.html)) +- make - please run below command. +```shell +#sudo may be required +apt install make +``` +In addition, below dependencies will be installed with `make install` command: - kubectl (install from [here](https://kubernetes.io/docs/tasks/tools/)) - kueuectl (install from [here](https://kueue.sigs.k8s.io/docs/reference/kubectl-kueue/installation/)) - kjob (installation instructions [here](https://github.com/kubernetes-sigs/kjob/blob/main/docs/installation.md)) + # Installation To install xpk, run the following command and install additional tools, mentioned in [prerequisites](#prerequisites). [Makefile](https://github.com/AI-Hypercomputer/xpk/blob/main/Makefile) provides a way to install all neccessary tools: