@node overview
@chapter Overview

This project aims to contain sufficient tools for generation, validation and packaging of metadata describing impacts and externalities from the use of Community Inclusion Currencies (CICs).

The expression of impacts and externalities will henceforth be referred to as @emph{attestations}.

@strong{This is a work in process. It is in alpha state, and may radically change at any time.}


@section Getting started

To build json schemas and run tests, please install the python dependencies from @file{requirements.txt}:

@code{pip install -r requirements.txt}

(You may want to use a virtual environment)


@section Project Structure

Each unit of metadata consists of two parts:

@enumerate
@item RDF documents the certifications of vouchers, accounts and transactions.
@item A JSON metadata structure bundlinf certficiations as tradeable NFTs.
@end enumerate

NFT tooling is at the current time intended for EVM blockchains only.