Sulkta-OSS/agora
3
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

minor tweaks to README.md

Browse source
This commit is contained in:
Jack Hodgkinson 2022-01-26 15:17:45 +00:00
parent f895a16731
commit fa1c2fa538
1 changed files with 19 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,40 +1,43 @@
# Agora # Agora
Agora is a set of Plutus scripts that compose together to form a Governance system. Agora is a set of Plutus scripts that compose together to form a governance system.
### What is Agora ### What is Agora
Goals: 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. - 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 blockchain.
- Agora aims to be modular and flexible for specific needs but presents an opinionated architecture.
Non-goals: 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/). - 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 ## 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. An up to date version of the [`nix` package manager](nixos.org) (>=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`. Open a dev-shell with `nix develop` and build with `cabal build`.
## Documentation ## Documentation
See documentation of the Agora architecture in [docs](./docs). Documentation for Agora may be found in [docs](./docs).
## Road-map ## Road-map
### v1 ### v1
- [ ] Governor
- [ ] Treasury - [ ] Governor
- [ ] Staking pool - [ ] Treasury
- [ ] Proposals - [ ] Staking pool
- [ ] Effects - [ ] Proposals
- [ ] Effects
### v2 ### v2
- [ ] Rewards distribution
- [ ] Rewards distribution
### Beyond ### Beyond
- [ ] ...