Skip to content

Commit

Permalink
Added initialization notes and changed example indentation to spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchPierias committed Apr 28, 2019
1 parent 9597354 commit 99aad26
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ From there you just need to add node scripts to your `package.json` file that tr

```
{
...
"scripts": {
"build": "lamington build",
"start": "lamington start eos",
"stop": "lamington stop eos",
"test": "lamington test"
},
...
...
"scripts": {
"build": "lamington build",
"start": "lamington start eos",
"stop": "lamington stop eos",
"test": "lamington test"
},
...
}
```

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

```
lamington build [identifier]
$ lamington build [identifier]
```

_Replace the `[identifier]` with the relative path to the contract with or without the .cpp extension._
Expand All @@ -93,30 +93,40 @@ _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;

```
lamington test
$ lamington test
```

For a full list of available JavaScript utilities, please [visit the documentation here](https://docs.lamington.io/testing).

## Configuration
### Initialization

Initially setting up a project can be tedious and repetitive, so we've created a simple CLI method to setup a boilerplate EOSIO project with Lamington integration.

```
$ lamington init
```

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;
This creates a `.lamingtonrc` file in your current directory with default Lamington settings.

```
lamington init
$ lamington init [PROJECT_NAME]
```

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.
Optionally you can provide and additional `PROJECT_NAME` to create a project directory and initialize a boilerplate project within.

## Configuration

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 a simple tool to get you started, simply run `lamington init` in your project directory to create a default `.lamingtonrc` configuration file.

### Using a Configuration File

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.
The `.lamingtonrc` file allows you to configure additional settings using JSON syntax. We're working on provide allot more settings, like defining multiple environments for each stage of your pipeline.

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

Expand Down

0 comments on commit 99aad26

Please sign in to comment.