From cbbedc1f3e3358f51170ff071c247743c26ce596 Mon Sep 17 00:00:00 2001 From: Ariel Gentile Date: Mon, 24 Jul 2023 03:50:40 -0300 Subject: [PATCH] docs: note about installing under Windows (#131) --- guides/getting-started/set-up/anoncreds-rs.md | 1 + guides/getting-started/set-up/aries-askar.md | 1 + guides/getting-started/set-up/indy-vdr.md | 1 + 3 files changed, 3 insertions(+) diff --git a/guides/getting-started/set-up/anoncreds-rs.md b/guides/getting-started/set-up/anoncreds-rs.md index bd99bb72..49b4e31c 100644 --- a/guides/getting-started/set-up/anoncreds-rs.md +++ b/guides/getting-started/set-up/anoncreds-rs.md @@ -9,6 +9,7 @@ Support for the AnonCreds RS library in Aries Framework JavaScript is currently Currently, there are few limitations to using AnonCreds RS. - When running in Node.JS, only Node.JS 18 is supported for now. See [Supported Node.JS versions for AnonCreds RS](#supported-nodejs-versions-for-anoncreds-rs) +- Install scripts rely on bash command substitution to get the proper binaries for each system architecture and platform. Therefore, if you are under Windows, you must configure `npm` or `yarn` to use a bash-compliant shell (e.g. `npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"`) ::: diff --git a/guides/getting-started/set-up/aries-askar.md b/guides/getting-started/set-up/aries-askar.md index 557d2a3b..627158e3 100644 --- a/guides/getting-started/set-up/aries-askar.md +++ b/guides/getting-started/set-up/aries-askar.md @@ -8,6 +8,7 @@ Although Aries Askar is stable and already used in production in agents such as Currently, there are few limitations to using Aries Askar. - When running in Node.JS, only Node.JS 18 is supported for now. See [Supported Node.JS versions for Aries Askar](#supported-nodejs-versions-for-aries-askar) +- Install scripts rely on bash command substitution to get the proper binaries for each system architecture and platform. Therefore, if you are under Windows, you must configure `npm` or `yarn` to use a bash-compliant shell (e.g. `npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"`) ::: diff --git a/guides/getting-started/set-up/indy-vdr.md b/guides/getting-started/set-up/indy-vdr.md index 9d676571..0ed40571 100644 --- a/guides/getting-started/set-up/indy-vdr.md +++ b/guides/getting-started/set-up/indy-vdr.md @@ -9,6 +9,7 @@ Support for Indy VDR in Aries Framework JavaScript is currently experimental. We Currently, there are few limitations to using Indy VDR. - When running in Node.JS, only Node.JS 18 is supported for now. See [Supported Node.JS versions for Indy VDR](#supported-nodejs-versions-for-indy-vdr) +- Install scripts rely on bash command substitution to get the proper binaries for each system architecture and platform. Therefore, if you are under Windows, you must configure `npm` or `yarn` to use a bash-compliant shell (e.g. `npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"`) :::