Skip to content

Commit

Permalink
Added configuration comment
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchPierias committed Apr 25, 2019
1 parent e1d8f17 commit fe1f9ed
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ Lamington requires Docker and NodeJS to be installed before it can be used.

Lamington includes command line tools and JavaScript utilities for EOSIO contract development. We recommend installing the framework as a development dependency within your project. This lets you run commands like `lamington test` in your project.

```
```bash
$ npm install --save-dev lamington
```

From there you just need to add node scripts to your `package.json` file that trigger `lamington` actions, for example:

```
```json
{
...
"scripts": {
Expand All @@ -57,7 +57,7 @@ If you'd like the convenience of using the `lamington` command without adding it

To install globally, run:

```
```bash
$ npm install -g lamington
```

Expand All @@ -69,7 +69,7 @@ Lamington is super simple! Whether you're migrating from Solidity, or a seasoned

Compiling your smart contracts with Lamington is as simple as;

```
```bash
$ lamington build
```

Expand All @@ -82,7 +82,7 @@ Not every `.cpp` file is a build ready contract. So we added an additional ignor
#### Specifying Build Contracts
If you'd like to run builds on specific contracts, an additional contract `identifier` can be specified like so;

```
```bash
lamington build [identifier]
```

Expand All @@ -92,7 +92,7 @@ _Replace the `[identifier]` with the relative path to the contract with or witho

Lamington was built with testing in mind. We considered the most commonly used testing libraries like Mocha when developing the Lamington toolset. Running your test suit is as easy as;

```
```bash
lamington test
```

Expand All @@ -102,16 +102,25 @@ For a full list of available JavaScript utilities, please [visit the documentati

Lamington ships with a default configuration to make getting started simple and setup free. However, as your project grows, so will your need for additional Lamington configuration. For example, deployment to a testnet or the live network will require environment setup. Additionally, you'll need customize your configuration if you'd like to control Lamington's fine grained settings. Fortunately we've made it easy to get started with a simple boilerplate generation method;

```
```bash
lamington init
```

This creates a `.lamingtonrc` file in your current directory which defaults to the latest available versions of EOS and EOS.CDT. The `.lamingtonrc` file allows you to configure additional settings using JSON syntax.

### Using a Configuration File

- Configuring environments
- keepAlive
The `.lamingtonrc` file provides custom configuration for your Lamington workspace. We're working on provide allot more settings, like defining multiple environments for each stage of your pipeline.

```json
{
...
"keepAlive":true,
...
}
```

The `keepAlive` setting prevents Lamington from stopping the EOSIO container between each build, allowing you to develop faster and compile often.

## Resources

Expand Down

0 comments on commit fe1f9ed

Please sign in to comment.