Update README.md (#106)

* update README.md

* split into DEVELOP.md and USAGE.md

Author: trxcllnt

DEVELOP.md

@@ -0,0 +1,23 @@
+# Contributing to the RAPIDS devcontainers
+
+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 which encapsulates a reusable bit of logic executed when building a Docker image.
+
+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-build](features/src/ninja/)
+* [NVIDIA HPC SDK](features/src/nvhpc/)
+* [Intel OneAPI compilers](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/)

README.md

@@ -1 +1,11 @@
-# RAPIDS devcontainer features and images
+# RAPIDS [devcontainers](https://containers.dev/)
+
+This repository contains features and workflows for building development containers to support local dev and CI for NVIDIA [RAPIDS](https://github.com/rapidsai), [CCCL](https://github.com/nvidia/cccl), and [Legate](https://github.com/nv-legate).
+
+We've chosen to use a monorepo, but it is similar in spirit to the official [devcontainers/features](https://github.com/devcontainers/features) and [devcontainers/images](https://github.com/devcontainers/images) repositories.
+
+### For details on using the RAPIDS devcontainers, see [`USAGE.md`](USAGE.md).
+
+### For details on contributing to this repository, see [`DEVELOP.md`](DEVELOP.md).
+
+### See the list of `rapidsai/devcontainers` tags [on DockerHub](https://hub.docker.com/r/rapidsai/devcontainers/tags).

USAGE.md

@@ -0,0 +1,11 @@
+# Using the RAPIDS devcontainers
+
+### See the list of `rapidsai/devcontainers` tags [on DockerHub](https://hub.docker.com/r/rapidsai/devcontainers/tags).
+
+We publish a [matrix](matrix.yml) of pre-built images to DockerHub to accelerate initializing local devcontainers, GitHub Codespaces, and CI jobs.
+
+The features that comprise the image are noted in the image tags. If no version is defined for a tool or SDK, the image includes the latest available version at image build time.
+
+> **NOTE:** `git`, `git-lfs`, `github-cli`, `gitlab-cli`, `cmake`, `ninja`, `sccache`, and the devcontainer utility scripts [are included](image/.devcontainer/devcontainer.json#L12-L33) in every pre-built image.
+
+These images can be used as the `"image"`, or as the base of a Dockerfile defined in the `"build"`, in your [`devcontainer.json`](https://containers.dev/implementors/json_reference/#image-specific).