From c6a46a729309c5a39b7b77d816a4dbcc67f849e5 Mon Sep 17 00:00:00 2001 From: giomba Date: Sun, 8 Jan 2023 22:35:37 +0100 Subject: [PATCH] Update README.md with CI best practices. --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 85a8a68..969260d 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,26 @@ Create `~/.config/it.linux.golem/component.conf` with following content: username=golem password=guess -## Dependencies -On Debian/Ubuntu/Mint: -* qt5-default -* TODO - -# Build +## Build +Download the build container: ``` -script/build +docker pull git.golem.linux.it/golem/gestionale-build ``` +Or, if you prefer, you can also build it by yourself: +``` +script/setup +``` + +Then, run all the commands in the build container, simply by preceding them with `docker`. +Example: +``` +./docker ls +``` + +Every command you'll ever need to build this software should be scripted inside the `script/` directory. + +Example: compile everything and produce executable. +``` +./docker script/build +```