added some more stubs to docs

This commit is contained in:
Resi Respati
2017-11-27 13:31:48 +07:00
parent 426b2d6207
commit ab1b01e8f5
3 changed files with 35 additions and 4 deletions

View File

@@ -1,3 +1,17 @@
# Screeps Typescript Starter
Screeps Typescript Starter is a starting point for a Screeps AI written in Typescript. It provides everything you need to start writing your AI whilst leaving `main.ts` as empty as possible.
## What's New
[TODO]
## Download
Download the latest source [here](https://github.com/screepers/screeps-typescript-starter/archive/v3.0.zip), or clone this repo.
```bash
git clone https://github.com/screepers/screeps-typescript-starter.git
```
Extract it to a folder, and let's get started!

View File

@@ -7,4 +7,11 @@
### Getting Started
* [Installation](./getting-started/installation.md)
* [Usage](./getting-starter/usage.md)
* [Usage](./getting-started/usage.md)
---
### Stuff You Might Want to Know
* Cookbook
* FAQ & Troubleshooting

View File

@@ -1,12 +1,22 @@
# Installation
## Requirements
You will need:
- Node.JS (Latest LTS is recommended)
- A Package Manager (Yarn or NPM)
Download the latest source [here](https://github.com/screepers/screeps-typescript-starter/archive/v3.0.zip) and extract it to a folder.
## Install `npm` Modules
Open the folder in your terminal and run `npm install` (or `yarn`) to install the dependencies.
Run the following the command to install the required packages and TypeScript declaration files:
Fire up your preferred editor with typescript installed and you are good to go!
```bash
npm install
```
Or if you're running `yarn`:
```bash
yarn
```