github.com/brandur/modulir@v0.0.0-20240305213423-94ee82929cbd/README.md (about)

     1  # Modulir [![Build Status](https://github.com/brandur/modulir/workflows/modulir%20CI/badge.svg)](https://github.com/brandur/modulir/actions)
     2  
     3  Modulir is an experimental mini-framework for static site
     4  generation that suggests that a site's main build recipe
     5  should be written in Go, both for type safety and to
     6  provide as much flexibility as possible.
     7  
     8  The main features that the package provides are an entry
     9  point that takes a build loop, a job pool for enqueuing the
    10  set of parallel jobs that make up the build, and a set of
    11  modules that provide helpers for various features in Go's
    12  core and in other useful libraries that would otherwise be
    13  quite verbose.
    14  
    15  The package is currently highly experimental and its APIs
    16  subject to change.
    17  
    18  ## Development
    19  
    20  Run tests:
    21  
    22      cp .envrc.sample .envrc # set with bin locations
    23      go test ./...
    24  
    25  <!--
    26  # vim: set tw=79:
    27  -->