Added initial docs
This commit is contained in:
3
docs/README.md
Normal file
3
docs/README.md
Normal 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
10
docs/SUMMARY.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Summary
|
||||
|
||||
* [Introduction](README.md)
|
||||
|
||||
---
|
||||
|
||||
### Getting Started
|
||||
|
||||
* [Installation](./getting-started/installation.md)
|
||||
* [Usage](./getting-starter/usage.md)
|
||||
12
docs/getting-started/installation.md
Normal file
12
docs/getting-started/installation.md
Normal 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!
|
||||
3
docs/getting-started/usage.md
Normal file
3
docs/getting-started/usage.md
Normal 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)*
|
||||
Reference in New Issue
Block a user