Basic readme and main.ts

This commit is contained in:
Adam Laycock
2017-11-21 19:46:10 +00:00
parent 3a76931275
commit 4d6ebf3ec9
2 changed files with 28 additions and 0 deletions

20
README.md Normal file
View File

@@ -0,0 +1,20 @@
# 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.
## Usage
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!
## Typings
The typings for Screeps comes from [typed-screeps](https://github.com/screepers/typed-screeps), if you have an issue with incorrect typings open an issue there.