= https://github.com/input-output-hk/marlowe-playground[Marlowe Playground] :email: plutus@iohk.io :author: Input Output HK Limited :toc: left :reproducible:
Marlowe is a platform for financial products as smart contracts. Marlowe Playground is a development tool that helps build and simulate Marlowe Contracts.
Related projects:
The rest of this README is focussed on people who want to develop or contribute to Marlowe.
====
DO NOT IGNORE THIS
== Documentation
== Working with the project
=== How to submit an issue
Issues can be filed in the https://github.com/input-output-hk/marlowe-playground/issues[GitHub Issue tracker].
[[how-to-develop]] === How to develop and contribute to the project
See link:CONTRIBUTING{outfilesuffix}[CONTRIBUTING], which describes our processes in more detail including development environments.
=== How to build the project's artifacts
This section contains information about how to build the project's artifacts for independent usage.
For development work see <
[[prerequisites]]
==== Prerequisites
The Haskell libraries in the Marlowe project are built with cabal
and Nix.
The other artifacts (docs etc.) are also most easily built with Nix.
===== Nix
Install https://nixos.org/nix/[Nix] (recommended). following the instructions on the https://nixos.org/nix/[Nix website].
Make sure you have read and understood the xref:cache-warning[cache warning]. DO NOT IGNORE THIS.
See <
===== Non-Nix
You can build some of the Haskell packages without Nix, but this is not recommended and we don't guarantee that these prerequisites are sufficient.
If you use Nix, these tools are provided for you via shell.nix
, and you do not need to install them yourself.
[[building-with-nix]] ==== Using Nix
Run nix develop
to enter the shell.
From there, you can type info
to get a list of available commands.
==== How to build the Haskell packages with cabal
The Haskell packages can be built directly with cabal
.
We do this during development (see <nix-shell
.
cabal update
.Run cabal build all
from the root to build all artifacts.
=== Deployment
The Marlowe Playground is automatically deployed upon certain pushes to GitHub
main
(these URLs subject to change)For more details, including instructions for setting up ad hoc testing deployments, see https://github.com/input-output-hk/plutus-ops[the plutus-ops repo].
[[nix-advice]] == Nix
[[iohk-binary-cache]] === How to set up the IOHK binary caches
Adding the IOHK binary cache to your Nix configuration will speed up builds a lot, since many things will have been built already by our CI.
If you find you are building packages that are not defined in this repository, or if the build seems to take a very long time then you may not have this set up properly.
To set up the cache:
/etc/nix/nix.conf
and add the following lines:
+/etc/nix/nix.conf
or don't want to edit it, you may add the nix.conf
lines to ~/.config/nix/nix.conf
instead.
You must be a https://nixos.org/nix/manual/#ssec-multi-user[trusted user] to do this.=== Nix on macOS
Nix on macOS can be a bit tricky. In particular, sandboxing is disabled by default, which can lead to strange failures.
These days it should be safe to turn on sandboxing on macOS with a few exceptions. Consider setting the following Nix settings, in the same way as in xref:iohk-binary-cache[previous section]:
Changes to /etc/nix/nix.conf
may require a restart of the nix daemon in order to take affect. Restart the nix daemon by running the following commands:
== Licensing
You are free to copy, modify, and distribute Marlowe under the terms of the Apache 2.0 license. See the link:./LICENSE[LICENSE] and link:./NOTICE[NOTICE] files for details.