From f7c146b3a01c77f51f963a04fae1d76336806198 Mon Sep 17 00:00:00 2001 From: Kyle Isom Date: Wed, 18 Oct 2023 18:22:19 -0700 Subject: [PATCH] Update README. --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 708a502..e25dc93 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,25 @@ used across shimmering clarity projects. ### Scripts -- build-all-containers.sh automates building all supported - containers. -- build-container.sh automated building and pushing a container. -- check-code.sh wraps several code scanning tools. -- install-cmake-debian.sh install the latest CMake on Debian- - based systems. -- install-depdendencies.sh installs the tools needed to build and + +- `build-all-containers.sh` automates building all supported containers. +- `build-container.sh` automated building and pushing a container. +- `check-code.sh` wraps several code scanning tools. +- `cmake-build-and-test.sh` sets up cmake projects building a + RelWithDebInfo config. +- `install-cmake-debian.sh` install the latest CMake on Debian-based + systems. +- `install-development-tools.sh` installs the tools needed to build and package projects. -- setup-cmake.sh sets up cmake projects building a RelWithDebInfo - config. -- validate-container.sh attempts to clone a few repos and build/test - them, validating that the image contains the correct tools to - build them. - - -- install-devenv.sh - check-code.sh +- `validate-container.sh` attempts to clone a few repos and build/test + them, validating that the image contains the correct tools to build + them. ### OCI imags -- Containerfile is an OCI-image spec for building development images. -- Containerfile.{flavor} provide additional images for testing. Current - flavors are: +- `Containerfile` is an OCI-image spec for building development images. +- `Containerfile.{flavor}` provide additional images for testing. + Current flavors are: - alpine: (Alpine 3.18) a minimal image, suitable for CI - debian: (Debian 12.2) verify Debian installation