Yui Ecosystem

To use this ecosystem ensure the $YUI_PATH variable points to this snapshot directory.

Bindings

A directory housing yui's C bindings. Used internally by libraries in this ecosystem.

Cue

A documentation generator which works by finding docstrings in yui source files.

To generate documentation for {path} run the command

./agency -- --roster cue/roster.yui {path}

A docstring is a block comment of the format {-| name? documentation -} placed before the symbol it documents. The name field is optional, when specified the generated documentation will use that name. The documentation field may be one or more lines describing the purpose, type, etc. of the documented symbol.

An example of a program with a documented function follows:

{
  {-| id
    The identity function

    id : a -> a
  -}
  id x = x
}

Cue (probably) does not work on literate files.

Debut

An alternate prelude which expands upon the built-in prelude of yui.

To open a debut repl run the command

./agency -- --roster debut/roster.yui repl public.debut

GetOpts

A simple library for reading program options from the command line

Random

A library with functions for generating random numbers or choosing random elements from lists and generic containers.

Store

A repository of packed agency packages. These are frozen, vendored packages that can be referenced as libraries or may be run as executables if they define an executable function.