From d5e0d01bcf9b1056c849b40b7419447c137293e9 Mon Sep 17 00:00:00 2001 From: Carlos Martinez Date: Thu, 31 Oct 2024 17:30:40 +0000 Subject: [PATCH] Update Ruby to 3.3.5 and use asdf --- .tool-versions | 1 + README.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 .tool-versions diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..1dd1998 --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +ruby 3.3.5 diff --git a/README.md b/README.md index f4201b7..f773deb 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ This is the repo for the [Teacher Services tech docs](https://tech-docs.teacherservices.cloud). +### Install build dependencies with ASDF + +The required versions of build tools are defined in [.tool-versions](.tool-versions). These can be automatically installed with [asdf-vm](https://asdf-vm.com/), see their [installation instructions](https://asdf-vm.com/#/core-manage-asdf). + +Install the plugin specified in `.tool-versions` + +```bash +asdf plugin add ruby +asdf install +``` + +(We don't mandate asdf, you can use other tools if you prefer.) + ## Developing on this project Copy `.env.example` to `.env` and populate a GitHub token with read access to repos.