From 5f86dc5893bc40ad66a657844ebe1d7b5783c9ba Mon Sep 17 00:00:00 2001 From: Franz-Stefan Preiss Date: Wed, 20 Sep 2023 01:10:11 +0200 Subject: [PATCH] Improve documentation for encrypted notes examples (#617) --- motoko/encrypted-notes-dapp-vetkd/README.md | 8 +++++++- motoko/encrypted-notes-dapp/README.md | 6 +----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/motoko/encrypted-notes-dapp-vetkd/README.md b/motoko/encrypted-notes-dapp-vetkd/README.md index 64230a987..3e6e372e9 100644 --- a/motoko/encrypted-notes-dapp-vetkd/README.md +++ b/motoko/encrypted-notes-dapp-vetkd/README.md @@ -15,10 +15,16 @@ Please also see the [README of the original encrypted-notes-dapp](../encrypted-n This example uses an [**insecure** implementation](../../rust/vetkd/src/system_api) of [the proposed vetKD system API](https://github.com/dfinity/interface-spec/pull/158) in a pre-compiled form via the [vetkd_system_api.wasm](./vetkd_system_api.wasm). **Do not use this in production or for sensitive data**! This example is solely provided **for demonstration purposes** to collect feedback on the mentioned vetKD system API. ## Manual local deployment -1. For **Motoko** deployment set environmental variable: +1. Choose which implementation to use by setting a respective environment variable. You can choose Motoko or Rust. + + For **Motoko** deployment use ```sh export BUILD_ENV=motoko ``` + For **Rust** deployment use + ```sh + export BUILD_ENV=rust + ``` 2. To generate `$BUILD_ENV`-specific files (i.e., Motoko or Rust) run: ```sh sh ./pre_deploy.sh diff --git a/motoko/encrypted-notes-dapp/README.md b/motoko/encrypted-notes-dapp/README.md index 8d740f1f0..08bc86031 100644 --- a/motoko/encrypted-notes-dapp/README.md +++ b/motoko/encrypted-notes-dapp/README.md @@ -121,11 +121,7 @@ Follow the steps below to deploy this sample project. cd examples/motoko/encrypted-notes-dapp ``` -or - -``` -cd examples/rust/encrypted-notes-dapp -``` +This project folder contains the files for both Motoko and Rust development. ### Step 2: Set an environmental variable reflecting which backend canister you'll be using: For Motoko deployment run: