History

joeduffy 9698309f2b Model resource ID and URN as output properties This change exposes ID and URN properties on resources, as appropriate, so that they may be read and used in Lumi scripts.		2017-06-14 17:00:13 -07:00
..
aws	Model resource ID and URN as output properties	2017-06-14 17:00:13 -07:00
lumi	Model resource ID and URN as output properties	2017-06-14 17:00:13 -07:00
lumijs	Add missing yarn link to Makefile	2017-06-13 18:19:04 -07:00
lumirt	Refactor runtime functionality	2017-06-13 18:11:59 -07:00
mantle	Implemented highlighted edits	2017-06-13 11:01:23 -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.