agora/README.md
2022-01-22 20:24:00 +01:00

23 lines
1.1 KiB
Markdown

# `agora`
Agora is a set of Plutus scripts that compose together to form a Governance system.
### What is Agora
Goals:
- Agora aims to reduce duplication in Liqwid and LiqwidX and to serve as a one-size-fits-all governance library for projects on the Cardano Network.
- Agora aims to be modular and allow customizing specific needs, but presents an opinionated architecture.
Non-goals:
- Agora is not a DAO. It doesn't have tokenomics or even a token. It is simply a library for governance.
- Agora doesn't aim to provide any primitive tools for plutus that are not governance-specific. For this, see [plutus-extra](https://github.com/Liqwid-Labs/plutus-extra/).
## Project setup
An up to date `nix` (>=2.3) is required to build this project. For information on how to install, see the [nixos website](https://nixos.org/download.html). Important: See also [this section](https://github.com/input-output-hk/plutus#nix-advice) on binary caches.
Open a dev-shell with `nix develop`, and build with `cabal build`.
## Documentation
See documentation of the agora architecture in [docs](./docs).