diff --git a/README.md b/README.md new file mode 100644 index 0000000..95c661e --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# mimi + +decentralised finance (DeFi) app prototype for the +(PolyFinTech100 API Hackathon)[https://www.polyfintech100hackathon.sg/] + +or, rather, the bare minimum of documentation to get this running + +## environment setup + +- python 3.10 and later, or 3.12 to be safe + +- [poetry](https://python-poetry.org/docs/#installation) +- +- `config.toml` + get the `config.toml` very securely stored in the group chat and place it in + the repository root / folder you `git clone`-d / downloaded this from + +## running it + +in a terminal, run: + +```text +poetry run flet run +``` + +and the window should pop up