Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.36 KB

README.md

File metadata and controls

58 lines (37 loc) · 2.36 KB
Raw

nix-templates

Test

Minimal reproducible nix flake templates.

What is the definition of minimum?

  • Hello World (eg: a script which prints "hello world").
  • LSP support (if available)
  • Code formatter (if available)
  • Docs (if available)

Usage

nix flake init -t github:LovelaceAcademy/nix-templates#template-name

Templates

  • agd: A minimal agda template
  • hask: A minimal haskell template
  • iogx: A haskell.nix (iogx) template
  • iogx-plutus: A plutus template using haskell.nix (iogx)
  • pix: A PureScript purs-nix template
  • pix-ctl: A minimal cardano-transaction-lib template using pix
  • pix-ctl-full: A optioned cardano-transaction-lib template using pix

FAQ

Why the templates have flake.lock files?

While I agree that storing lock files in templates is not ideal, there is no way to be sure the template is working if we do not store lock files. It's a trade-off, we prefer to have working templates than up-to-date dependencies. That said, we try to keep all templates here in sync with upstream / dependencies as far as possible.

Will you support other systems?

It depends on upstream supporting it, and also our capacity to test in our CI. Right now only these systems are supported:

  • x86_64-linux (all templates)

Minimal system requirements?

It depends on the template:

  • agd, hask, pix: 4GB RAM and 5GB HDD
  • iogx: 8GB RAM and 10GB HDD
  • iogx-plutus, pix-ctl: 16GB RAM (for HDD) / 12GB RAM (for SSD). At least 20GB of available space.

Why it take soo long to build?

  • You can use prebuilt binaries if you accept flake cache settings, to do that you need to be a trusted-user.
  • Haskell.nix (iogx) is known for having slow evaluation/build times.
  • If you hardware is constrained it will take more time building, using a SSD will potentially speed-up things. Remember to close everything in the first build to not be OOM killed.

I am getting No such file or directory

This is a know issue (NixOS/nix#6642). Be sure to initialize a git repo before (git init).