README.md

Documentation

This repository contains documentation relating to the usage and testing of the liquality swap interface.

• Executing a Swap
• Setting up your local environment

Contributing

This documentation uses mkdocs, please follow this steps to contribute:

• Install VirtualEnv, run pip install virtualenv
• Use the env created: virtualenv -p python3 venv then source venv/bin/activate
• Install mkdocs: pip install mkdocs
• Install matherial theme for mkdocs: pip install mkdocs-material
• Run mkdocs serve to start the local webserver