diff --git a/.gitignore b/.gitignore index 1db149c..e23369d 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ /.rpt2_cache /tsc-out /node_modules +/_book # TypeScript definitions installed by Typings /typings diff --git a/book.json b/book.json new file mode 100644 index 0000000..b561406 --- /dev/null +++ b/book.json @@ -0,0 +1,5 @@ +{ + "title": "Screeps Typescript Starter", + "description": "Starter kit for TypeScript-based Screeps AI codes.", + "root": "./docs" +} diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..94c28b7 --- /dev/null +++ b/docs/README.md @@ -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. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..609acfa --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,10 @@ +# Summary + +* [Introduction](README.md) + +--- + +### Getting Started + +* [Installation](./getting-started/installation.md) +* [Usage](./getting-starter/usage.md) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md new file mode 100644 index 0000000..6632b92 --- /dev/null +++ b/docs/getting-started/installation.md @@ -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! diff --git a/docs/getting-started/usage.md b/docs/getting-started/usage.md new file mode 100644 index 0000000..3720b7d --- /dev/null +++ b/docs/getting-started/usage.md @@ -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)*