Added initial docs

This commit is contained in:
Resi Respati
2017-11-27 11:59:00 +07:00
parent 56840c0adf
commit 426b2d6207
6 changed files with 34 additions and 0 deletions

1
.gitignore vendored
View File

@@ -9,6 +9,7 @@
/.rpt2_cache /.rpt2_cache
/tsc-out /tsc-out
/node_modules /node_modules
/_book
# TypeScript definitions installed by Typings # TypeScript definitions installed by Typings
/typings /typings

5
book.json Normal file
View File

@@ -0,0 +1,5 @@
{
"title": "Screeps Typescript Starter",
"description": "Starter kit for TypeScript-based Screeps AI codes.",
"root": "./docs"
}

3
docs/README.md Normal file
View File

@@ -0,0 +1,3 @@
# 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.

10
docs/SUMMARY.md Normal file
View File

@@ -0,0 +1,10 @@
# Summary
* [Introduction](README.md)
---
### Getting Started
* [Installation](./getting-started/installation.md)
* [Usage](./getting-starter/usage.md)

View File

@@ -0,0 +1,12 @@
# Installation
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.
Open the folder in your terminal and run `npm install` (or `yarn`) to install the dependencies.
Fire up your preferred editor with typescript installed and you are good to go!

View File

@@ -0,0 +1,3 @@
# Usage
*This page is a stub. [Help expand it?](https://github.com/screepers/screeps-typescript-starter/blob/v3.0/docs/getting-started/usage.md)*