Skip to content

qrlex/nightfall

 
 

Repository files navigation

nightfall

A Haskell eDSL for targeting different zk-VMs.

WARNING: This project is work in progress and subject to frequent changes. It has not been audited and may contain bugs and security flaws. This implementation is NOT ready for production use.


Table of Contents

  1. Getting Started
  2. Usage
  3. Contributing
  4. License

Getting Started

These instructions will help you set up and run nightfall on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following software installed on your system:

  1. nix (version 2.15.0 or later)

Usage

To run nightfall on your local machine, follow these steps:

nix-shell --run "cabal run"

Contributing

We welcome contributions to nightfall! To contribute, please follow these steps:

  • Fork the repository and clone it locally.
  • Create a new branch (git checkout -b feature/YourFeature)
  • Commit your changes (git commit -m 'Add YourFeature')
  • Push to the branch (git push origin feature/YourFeature)
  • Create a Pull Request
  • Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

Licence

This project is released under the terms of the Apache 2.0 License - see the LICENSE file for details. The repository is REUSE compliant. The copyright owner are listed in the .reuse/dep5 file or in the respective copyright notice.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Haskell 91.0%
  • Nix 9.0%