From c2a2da78a2d3cb936268ce69158084e1fa7ca680 Mon Sep 17 00:00:00 2001 From: ptaylor Date: Tue, 1 Aug 2023 10:25:10 -0700 Subject: [PATCH] update README.md --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e941af0a..2f7c21729 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# RAPIDS devcontainer features and images +# NVIDIA RAPIDS [Development Containers](https://containers.dev/) + +[Click here to see the list of `rapidsai/devcontainers` tags available in DockerHub.](https://hub.docker.com/r/rapidsai/devcontainers/tags) + +This repository contains devcontainers and features supporting NVIDIA [RAPIDS](https://github.com/rapidsai), [CCCL](https://github.com/nvidia/cccl), and [Legate](https://github.com/nv-legate) development and continuous integration. + +This repo is similar to the [devcontainers/features](https://github.com/devcontainers/features) and [devcontainers/images](https://github.com/devcontainers/images) repos, except we have chosen to use a monorepo to make packaging and versioning easier. + +## Pre-built [Images](https://hub.docker.com/r/rapidsai/devcontainers/tags) + +We publish a [matrix](matrix.yml) of pre-built images to DockerHub in order to speed up initialization of local devcontainers, GitHub Codespaces, and CI jobs. + +The images are compose of [features](https://containers.dev/implementors/features/), many of which are also defined in this repository (see [Features](#features) below). + +All the prebuilt images [contain](image/.devcontainer/devcontainer.json#L12-L33) `git`, `git-lfs`, `github-cli`, `gitlab-cli`, `cmake`, `ninja`, `sccache`, and our devcontainer utility scripts to automate certain in-container tasks. The images in `matrix.yml` extend this set of features by adding various dev tools, compilers, and SDKs. + +## Reusable [Features](features/) + +From the official devcontainer [documentation on Features](https://containers.dev/implementors/features/): +> Development container "Features" are self-contained, shareable units of installation code and development container configuration. + +In short, a "feature" is a layer in a Dockerfile. A feature encapsulates a reusable bit of logic to run during a dockerfile build. + +This repository defines features to install the following dev tools, compilers, and SDKs: + +* [CMake](features/src/cmake/) +* [CUDA Toolkit](features/src/cuda/) +* [GCC](features/src/gcc/) +* [GitLab-cli](features/src/gitlab-cli/) +* [LLVM](features/src/llvm/) +* [Mambaforge](features/src/mambaforge/) +* [ninja](features/src/ninja/) +* [NVIDIA HPC SDK](features/src/nvhpc/) +* [Intel OneAPI](features/src/oneapi/) +* [lit (from pypi)](features/src/python-lit/) +* [Rust](features/src/rust/) +* [sccache](features/src/sccache/) +* [devcontainer-utils](features/src/utils/) +* [rapids-build-utils](features/src/rapids-build-utils/)