regen docs to reflect change of ownership in repo. Added how to gen docs in readme

2026-07-12 17:21:05 -07:00 · 2024-12-31 02:01:35 +00:00
parent bd252c3aed
commit 27b6abc928
46 changed files with 168 additions and 98 deletions
@@ -44,4 +44,14 @@ The available commands are:

 Build simply builds the test project, while launch both builds and runs it. If you've made changes to lib, be sure to build there first.

-Before launching, you should setup environment variables. `sample.env` shows you what variables are necessary. Copy the contents to a new file, `.env`, in the same folder and populate it appropriately.
+Before launching, you should setup environment variables. `sample.env` shows you what variables are necessary. Copy the contents to a new file, `.env`, in the same folder and populate it appropriately.
+
+## Contributing
+
+### Updating Docs
+
+To update typedoc docs after changes to code, run in the root of the repo:
+
+```npm install```
+
+```npm run docs```