sjoerdvisscher / cardano-node-emulator

Cardano Node Emulator

Table of Contents

• Introduction
• Architecture
• Development
  • How to develop and contribute to the project
• Documentation
  • User documentation
• Working with the project
  • How to submit an issue
  • How to develop and contribute to the project
• Licensing

Introduction

TODO

Architecture

The repository consists of a set of components:

• cardano-node-emulator

Development

How to develop and contribute to the project

Run nix develop to enter the development shell and you will be presented with a list of available commands.

*Please see CONTRIBUTING for comprehensive documentation on how to contribute to the project, including development and submitting changes

Documentation

User documentation

User documentations are work in progress. You may generate Haskell API documentation (haddocks) directly from nix develop for each of the components:

cabal haddock cardano-node-emulator

Working with the project

How to submit an issue

Issues can be filed in the GitHub Issue tracker.

However, note that this is pre-release software, so we will not usually be providing support.

How to develop and contribute to the project

See CONTRIBUTING, which describes our processes in more detail including development environments; and Architecture, which describes the structure of the repository.

Licensing

You are free to copy, modify, and distribute the Cardano Node Emulator Library under the terms of the Apache 2.0 license. See the LICENSE and NOTICE files for details.