From adbb7f07c50cef720e1efd8f05c2d1dd586ce618 Mon Sep 17 00:00:00 2001 From: Michael Cooper Date: Mon, 9 Sep 2024 14:22:47 -0700 Subject: [PATCH 1/2] Update versions in README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3f5ec2b..77cb082 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,10 @@ It includes support for running Framework data loaders with the following langua - Node 20 - Python 3.11 -- R 4.3 -- duckdb 0.10.1 -- Rust 1.77 +- R 4.4 +- duckdb 1.0 +- Rust 1.81 +- Perl 5.36 ## Usage @@ -28,7 +29,7 @@ This will install dependencies needed for the repository, and build the image. To run the image, you can use the command ``` -docker run -it observablehq/framework-runtime:latest bash +docker run -it ghcr.io/observablehq/framework-runtime:latest bash ``` This will launch a shell in the runtime environment. From here you should be able to clone repositories, use `npm init @observablehq`, and otherwise interact with Framework projects. Not that after exiting the shell any files you worked with will be lost. Consider using [Docker Volumes](https://docs.docker.com/storage/volumes/) if you want a persistent environment. From 3cd422d5c2965097d3ecfa1327d55e900b253244 Mon Sep 17 00:00:00 2001 From: Michael Cooper Date: Mon, 9 Sep 2024 14:27:05 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 77cb082..e1ba3cc 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,15 @@ It includes support for running Framework data loaders with the following langua ## Usage -This will be published on a public repository soon. In the mean time, please use the local development instructions below. +The image built from this repository is published on the GitHub container registry. + +``` +docker run -it ghcr.io/observablehq/framework-runtime +``` ## Local development -From this repository, run +To build and test the images locally, from this repository, run ``` yarn install @@ -29,7 +33,13 @@ This will install dependencies needed for the repository, and build the image. To run the image, you can use the command ``` -docker run -it ghcr.io/observablehq/framework-runtime:latest bash +docker run -it observablehq/framework-runtime:latest bash ``` This will launch a shell in the runtime environment. From here you should be able to clone repositories, use `npm init @observablehq`, and otherwise interact with Framework projects. Not that after exiting the shell any files you worked with will be lost. Consider using [Docker Volumes](https://docs.docker.com/storage/volumes/) if you want a persistent environment. + +There are automated tests that ensure that various commands and tools are available, and of the expected versions. To run those, use + +``` +yarn test +```