Update README.

This commit is contained in:
Kyle Isom 2023-10-18 18:22:19 -07:00
parent 48ca042005
commit f7c146b3a0
1 changed files with 15 additions and 18 deletions

View File

@ -6,28 +6,25 @@ used across shimmering clarity projects.
### Scripts ### Scripts
- build-all-containers.sh automates building all supported
containers. - `build-all-containers.sh` automates building all supported containers.
- build-container.sh automated building and pushing a container. - `build-container.sh` automated building and pushing a container.
- check-code.sh wraps several code scanning tools. - `check-code.sh` wraps several code scanning tools.
- install-cmake-debian.sh install the latest CMake on Debian- - `cmake-build-and-test.sh` sets up cmake projects building a
based systems. RelWithDebInfo config.
- install-depdendencies.sh installs the tools needed to build and - `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. package projects.
- setup-cmake.sh sets up cmake projects building a RelWithDebInfo - `validate-container.sh` attempts to clone a few repos and build/test
config. them, validating that the image contains the correct tools to build
- validate-container.sh attempts to clone a few repos and build/test them.
them, validating that the image contains the correct tools to
build them.
- install-devenv.sh - check-code.sh
### OCI imags ### OCI imags
- Containerfile is an OCI-image spec for building development images. - `Containerfile` is an OCI-image spec for building development images.
- Containerfile.{flavor} provide additional images for testing. Current - `Containerfile.{flavor}` provide additional images for testing.
flavors are: Current flavors are:
- alpine: (Alpine 3.18) a minimal image, suitable for CI - alpine: (Alpine 3.18) a minimal image, suitable for CI
- debian: (Debian 12.2) verify Debian installation - debian: (Debian 12.2) verify Debian installation