From 20b05404b903ac1744531de6d1e67de989adf354 Mon Sep 17 00:00:00 2001 From: Trent Larson Date: Fri, 21 Apr 2023 22:17:47 -0600 Subject: [PATCH 1/2] Add shell setup using tea --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 715f6c3..afc541e 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,15 @@ This is the companion repository for the *KERI Tutorial Series: Treasure Hunting ## Dependencies +| Project | Version | +|---------------|----------| +| libsodium.org | ^1.0.18 | +| python.org | ^3.11.2 | +| rust-lang.org | ^1.65.0 | + +If you don't have [tea](tea.xyz) already installed, +run the following in this directory to start a temporary shell with those basic tools: `sh <(curl tea.xyz) -E sh` + - [kaslcred](https://pypi.org/project/kaslcred/) for generation of schemas - [vLEI server (vLEI-server)](https://github.com/WebOfTrust/vLEI) - [sally](https://github.com/kentbull/sally) @@ -107,4 +116,4 @@ Make sure you are running the script from the root of the repository. ### Double quoting to prevent word splitting -Use `"${VARNAME}"` instead of `${VARNAME}`. See [SC2086](https://github.com/koalaman/shellcheck/wiki/SC2086) \ No newline at end of file +Use `"${VARNAME}"` instead of `${VARNAME}`. See [SC2086](https://github.com/koalaman/shellcheck/wiki/SC2086) From 51bea1d029766d23090c41f1ac7337eafb5798b8 Mon Sep 17 00:00:00 2001 From: Trent Larson Date: Fri, 21 Apr 2023 22:40:15 -0600 Subject: [PATCH 2/2] improve wording for tea setup instruction --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index afc541e..05c8895 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,10 @@ This is the companion repository for the *KERI Tutorial Series: Treasure Hunting | python.org | ^3.11.2 | | rust-lang.org | ^1.65.0 | -If you don't have [tea](tea.xyz) already installed, -run the following in this directory to start a temporary shell with those basic tools: `sh <(curl tea.xyz) -E sh` +One approach is to run the following command in this directory, +which will start a temporary shell with those basic tools +but will not make permanent changes to your machine: `sh <(curl tea.xyz) -E sh` +(We recommend installing [tea](tea.xyz) but it is not necessary.) - [kaslcred](https://pypi.org/project/kaslcred/) for generation of schemas - [vLEI server (vLEI-server)](https://github.com/WebOfTrust/vLEI)