From 8588664043bab97abf02edc5d34fe7ba98bdffec Mon Sep 17 00:00:00 2001 From: Jan Eitzinger Date: Wed, 22 Feb 2023 10:04:37 +0100 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 93dd3db..be65ae1 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,17 @@ You find more detailed information here: * `./tools/README.md`: Infos on the JWT authorizatin token workflows in ClusterCockpit. * `./docs`: You can find further documentation here. There is also a Hands-on tutorial that is recommended to get familiar with the ClusterCockpit setup. +**NOTICE** + +ClusterCockpit requires a recent version of the golang toolchain. +You can check in `go.mod` what is the current minimal golang version required. +Homebrew and Archlinux usually have up to date golang versions. For other Linux +distros this often means you have to install the golang compiler yourself. +Fprtunatly this is easy with golang. Since a lot of functionality is based on +the go standard library it is crucial for security and performance to use a +recent golang version. Also an old golang tool chain may restrict the supported +versions of third party packages. + ## Demo Setup We provide a shell skript that downloads demo data and automatically builds and starts cc-backend. @@ -44,17 +55,6 @@ Please note that some views do not work without a metric backend (e.g., the Syst ## Howto Build and Run -**NOTICE** - -ClusterCockpit requires a recent version of the golang toolchain. -You can check in `go.mod` what is the current minimal golang version required. -Homebrew and Archlinux usually have up to date golang versions. For other Linux -distros this often means you have to install the golang compiler yourself. -Fprtunatly this is easy with golang. Since a lot of functionality is based on -the go standard library it is crucial for security and performance to use a -recent golang version. Also an old golang tool chain may restrict the supported -versions of third party packages. - There is a Makefile to automate the build of cc-backend. The Makefile supports the following targets: * `$ make`: Initialize `var` directory and build svelte frontend and backend binary. Please note that there is no proper prerequesite handling. Any change of frontend source files will trigger a complete rebuild. * `$ make clean`: Clean go build cache and remove binary