Skip to content

Commit 426b2d6

Browse files
committed
Added initial docs
1 parent 56840c0 commit 426b2d6

File tree

6 files changed

+34
-0
lines changed

6 files changed

+34
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
/.rpt2_cache
1010
/tsc-out
1111
/node_modules
12+
/_book
1213

1314
# TypeScript definitions installed by Typings
1415
/typings

book.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"title": "Screeps Typescript Starter",
3+
"description": "Starter kit for TypeScript-based Screeps AI codes.",
4+
"root": "./docs"
5+
}

docs/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Screeps Typescript Starter
2+
3+
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.

docs/SUMMARY.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Summary
2+
3+
* [Introduction](README.md)
4+
5+
---
6+
7+
### Getting Started
8+
9+
* [Installation](./getting-started/installation.md)
10+
* [Usage](./getting-starter/usage.md)

docs/getting-started/installation.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Installation
2+
3+
You will need:
4+
5+
- Node.JS (Latest LTS is recommended)
6+
- A Package Manager (Yarn or NPM)
7+
8+
Download the latest source [here](https://github.com/screepers/screeps-typescript-starter/archive/v3.0.zip) and extract it to a folder.
9+
10+
Open the folder in your terminal and run `npm install` (or `yarn`) to install the dependencies.
11+
12+
Fire up your preferred editor with typescript installed and you are good to go!

docs/getting-started/usage.md

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

0 commit comments

Comments
 (0)