From 062b76a35135b875179fe74a3f84a3f7806de87a Mon Sep 17 00:00:00 2001 From: Resi Respati Date: Tue, 28 Nov 2017 13:39:03 +0700 Subject: [PATCH] [docs] "Configuration variables" -> "Deploy destinations" --- docs/SUMMARY.md | 2 +- docs/getting-started/installation.md | 3 ++- docs/in-depth/cookbook.md | 2 +- ...iguration-variables.md => deploy-destinations.md} | 12 +++++++++--- 4 files changed, 13 insertions(+), 6 deletions(-) rename docs/in-depth/{configuration-variables.md => deploy-destinations.md} (60%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index c3161e5..94920db 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -12,7 +12,7 @@ ### In-Depth * [Module bundling](./in-depth/module-bundling.md) -* [Configuration variables](./in-depth/configuration-variables.md) +* [Deploy destinations](./in-depth/deploy-destinations.md) * [TypeScript](./in-depth/typescript.md) * [Cookbook](./in-depth/cookbook.md) * [TODO] diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index af09680..084167b 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -5,7 +5,8 @@ You will need: - Node.JS (Latest LTS is recommended) - - A Package Manager (Yarn or NPM) + - A Package Manager (`yarn` or `npm`) + - Rollup CLI (Optional, install via `npm install -g rollup`) ## Installing `npm` modules diff --git a/docs/in-depth/cookbook.md b/docs/in-depth/cookbook.md index 34e10fd..1bb4e06 100644 --- a/docs/in-depth/cookbook.md +++ b/docs/in-depth/cookbook.md @@ -1,3 +1,3 @@ # Cookbook -This section a community-maintained list of slightly more advanced tips and tricks to help better improve your Screeps AI development workflow with TypeScript. Feel free to [contribute your own](https://github.com/screepers/screeps-typescript-starter/tree/v3.0/docs)! +This section contains a community-maintained list of slightly more advanced tips and tricks to help better improve your Screeps AI development workflow with TypeScript. Feel free to [contribute your own](https://github.com/screepers/screeps-typescript-starter/tree/v3.0/docs)! diff --git a/docs/in-depth/configuration-variables.md b/docs/in-depth/deploy-destinations.md similarity index 60% rename from docs/in-depth/configuration-variables.md rename to docs/in-depth/deploy-destinations.md index 6102974..2b3e06a 100644 --- a/docs/in-depth/configuration-variables.md +++ b/docs/in-depth/deploy-destinations.md @@ -1,6 +1,6 @@ -# Configuration variables +# Deploy destination -The `screeps.json` file is a JSON configuration file separated into multiple environments. We've given you three primary environments by default. +The `screeps.json` file is a JSON configuration file separated into multiple deploy destinations. We've given you three primary destinations by default. ```json { @@ -37,4 +37,10 @@ The `screeps.json` file is a JSON configuration file separated into multiple env } ``` -[TODO: running environments] +You can make as many separate destinations as you want. Just make a copy of any config object and perform the necessary changes. Once you're done, use the `--dest` argument on the `rollup` command to specify which environment to upload to. + +```bash +rollup -c --dest main +``` + +Omitting the `--dest` argument will perform a dry run, which can be used for local directories via symlinks.