This project contains the build systems and scripts needed to scaffold a plutus project quickly.
To get everything set up, copy the contents of this repo to your new project. You will then need to run the setup.sh script, which can take 0, 2, or 3 arguments.
- When given 0 arguments, it will prompt you to provide the project name, module name, and github URL.
- When given 2 arguments, the first should be the project name, and the second should be the module name, e.g.,
./setup.sh gero-gov GeroGov. In this case, you will still be prompted for a github URL. - Finally, you may provide all three pieces of information at the command line, e.g.,
./setup.sh gero-gov GeroGov https://github.com/mlabs-haskell/gero-gov.
- If you submit your pull request, but get an error on the GitHub CIs saying something to the effect of "Binary cache mlabs doesn't exist or it's private," or that MLabs.cachix.com doesn't exist, then the cachix key is not setup, and you or whoever owns your repository will have to add that.
- If you get an error saying that "The package directory './.' does not contain any .cabal file," then you probably should either start with a fresh repository with no commits, or you should make a commit with git and rerun
nix-build nix/ci.nix. This issue arises because nix is looking in your .git folder to try and identify what your .cabal file is, and since that has been renamed, nix seems to assume that there is no .cabal file. Starting with a fresh repo causes it to search the directory for your .cabal file, and making a commit changes the file name in the .git folder.