History

joeduffy 232ed7e248 Goodbye, custom AWS provider code 😥 Preparing to RI the tfbridge branch into master.		2017-07-21 14:41:01 -07:00
..
lumi	Revert "Rename Lumi resource properties"	2017-07-15 09:33:23 -07:00
lumijs	Support try/catch in Lumi and async/await in Node.js	2017-07-07 12:47:27 -07:00
lumirt	Add a rudimentary toString runtime helper	2017-07-17 13:43:59 -07:00
README.md	Preserve the lumi prefix on our CLI tools	2017-05-18 12:38:58 -07:00

README.md

lumi/lib

This directory contains some libraries that Lumi programs may depend upon.

Overview

The Lumi standard library underneath lumi/ is special in that every program will ultimately use it directly or indirectly to create resources.

Similarly, lumijs/ is the LumiJS compiler's runtime library, and so most LumiJS programs will on it.

Note that these are written in the Lumi subsets of the languages and therefore cannot perform I/O, etc.

Installation and Usage

Eventually these packages will be published like any other NPM package. For now, they are consumed only in a development capacity, and so there are some manual steps required to prepare a developer workspace.

For each library <lib> you wish to use, please see its install.sh script in its root directory. This performs installation so that it can be used simply by adding a dependency to it.

We currently use NPM/Yarn symlinks to ease the developer workspace flow. As such, you will need to run:

yarn link <lib>

In a project that intends to consume <lib> before actually using it. For example, yarn link @lumi/lumi.