HideyoshiNakazone/screeps-scripts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] fixing headings on 'Deploying' page

Browse Source
This commit is contained in:
Resi Respati
2017-11-27 19:28:27 +07:00
parent b929c4aec6
commit f76d213b60
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/getting-started/deploying.md
View File

@@ -1,6 +1,6 @@
# Deploying # Deploying
## Building Configuration Files ## Building Your Configuration File
The starter kit builds your code using `rollup`, which uses a `screeps.json` file as its configuration file. A sample config file is provided within the project, to use it, simply make a copy and rename it to `screeps.json`. The starter kit builds your code using `rollup`, which uses a `screeps.json` file as its configuration file. A sample config file is provided within the project, to use it, simply make a copy and rename it to `screeps.json`.
@@ -49,16 +49,22 @@ The `screeps.json` file is a JSON configuration file that can be separated into
} }
``` ```
[/TODO: move to 'in-depth']
We're going to focus on the `main` environment as a starter. Fill in your Screeps credentials accordingly, along with your target branch. We're going to focus on the `main` environment as a starter. Fill in your Screeps credentials accordingly, along with your target branch.
> **Note:** You don't have to manually create the branch in your Screeps client if it doesn't exist yet. `rollup` will do it for you. > **Note:** You don't have to manually create the branch in your Screeps client if it doesn't exist yet. `rollup` will do it for you.
## Running Your First Deploy
Once you're done, run the following command: Once you're done, run the following command:
```bash ```bash
npm run push-main npm run push-main
``` ```
Now go to your Screeps client and make sure your code is deployed properly. You're done! Now go to your Screeps client and make sure your code is deployed properly.
![deploying-1](img/deploying-1.png) ![deploying-1](img/deploying-1.png)
Ready for something extra? Read on.