From 88c0935b2984ba890708ee2fa1162110a2b54614 Mon Sep 17 00:00:00 2001 From: armaniferrante Date: Thu, 11 Mar 2021 08:40:39 -0800 Subject: [PATCH] Update README --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index a3cbf24..48a2a8d 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,38 @@ account, specifying the parameters for a normal solana transaction. To sign, owners should invoke the `approve` instruction, and finally, the `execute_transaction`, once enough (i.e. `threhsold`) of the owners have signed. + +## Note + +* **This code is unaudited. Use at your own risk.** + +## Developing + +[Anchor](https://github.com/project-serum/anchor) is used for developoment, and it's +recommended workflow is used here. To get started, see the [guide](https://project-serum.github.io/anchor/getting-started/introduction.html). + +### Build + +```bash +anchor build --verifiable +``` + +The `--verifiable` flag should be used before deploying so that your build artifacts +can be deterministically generated with docker. + +### Test + +```bash +anchor test +``` + +### Verify + +To verify the program deployed on Solana matches your local source code, install +docker, `cd programs/multisig`, and run + +```bash +anchor verify +``` + +A list of build artifacts can be found under [releases](https://github.com/project-serum/multisig/releases).