docs: -goals, tools

Agoric · Mar 15, 2024 · f1b98c8 · f1b98c8
1 parent 79c3fa7
commit f1b98c8
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/contract/src/platform-goals/README.md b/contract/src/platform-goals/README.md
@@ -0,0 +1,5 @@
+# Platform Goals
+
+Work on this dapp shows some ways that the platform could be improved.
+
+The code in this directory shows some possible platform refinements.
diff --git a/contract/tools/README.md b/contract/tools/README.md
@@ -0,0 +1,7 @@
+# Contract deployment and end-to-end testing tools
+
+These tools are an attempt to mix testing in the style of the [makeWalletFactoryDriver][1] API in ava with experience from testing on live blockchains in [a3p](https://github.com/Agoric/agoric-3-proposals). _See also [testing API to extend ava functional tests to end-to-end context #8963](https://github.com/Agoric/agoric-sdk/issues/8963)._
+
+`deploy-contract.js` in the `contract/scripts` directory makes them available as a CLI tool.
+
+[1]: https://github.com/Agoric/agoric-sdk/blob/b13743a2cccf0cb63a412b54384435596d4e81ea/packages/boot/tools/drivers.ts#L28
diff --git a/contract/tools/ui-kit-goals/README.md b/contract/tools/ui-kit-goals/README.md
@@ -0,0 +1,5 @@
+# Goals for ui-kit
+
+Work on this dapp suggests some ways that ui-kit could be improved. For example, [#79 pass network access explicitly](https://github.com/Agoric/ui-kit/issues/79).
+
+The code in this directory shows some possible platform refinements.