Skip to content

Commit 0b4822c

Browse files
committed
Swap README placeS
1 parent 5d94592 commit 0b4822c

File tree

2 files changed

+53
-53
lines changed

2 files changed

+53
-53
lines changed

README.md

-52
This file was deleted.

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book/README.md

book/README.md

-1
This file was deleted.

book/README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
screeps-starter-python
2+
======================
3+
4+
[![MIT licensed][mit-badge]][mit-url]
5+
[![Slack Chat][slack-badge]][slack-url]
6+
[![Docs Built][docs-badge]][docs-url]
7+
8+
This repository is a starter Python AI written for the JavaScript based MMO
9+
game, [screeps](https://screeps.com).
10+
11+
12+
While code uploaded to the server must be in JavaScript, this repository is
13+
written in Python. We use the [Transcrypt](https://github.com/QQuick/Transcrypt)
14+
transpiler to transpile the python programming into JavaScript.
15+
16+
Specifically, it uses [my fork of
17+
transcrypt](https://github.com/daboross/Transcrypt) built with [a few
18+
modifications](https://github.com/daboross/Transcrypt/commits/screeps-safe-modifications)
19+
intended to reduce the overhead of running Python in the Screeps
20+
environment. Nothing against Transcrypt itself, and you're free to change the
21+
installed fork my modifying `requirements.txt`! I've just found a few changes
22+
useful that I've tested in node.js and the screeps environment, but that I don't
23+
have time to generalize enough to include in the main transcrypt codebase.
24+
25+
This repository is intended as a base to be used for building more complex AIs,
26+
and has all the tooling needed to transpile Python into JavaScript set up.
27+
28+
## Install
29+
30+
To get started, check out the [Setup
31+
Guide](https://daboross.gitbook.io/screeps-starter-python/overview/setup).
32+
33+
## Docs
34+
35+
For a documentation index, see [The
36+
Book](https://daboross.gitbooks.io/screeps-starter-python/), and for the
37+
main differences between Python and Transcrypt-flavored-Python, see [Syntax
38+
Changes](https://daboross.gitbooks.io/screeps-starter-python/syntax-changes/).
39+
40+
## Community
41+
42+
Join us on the [Screeps Slack][slack-url]! We're in
43+
[#python](https://screeps.slack.com/archives/C2FNJBGH0) (though you need to sign
44+
up with the first link first :).
45+
46+
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
47+
[mit-url]: https://github.com/daboross/screeps-starter-python/blob/master/LICENSE
48+
[slack-badge]: https://img.shields.io/badge/chat-slack-2EB67D
49+
[slack-url]: https://chat.screeps.com/
50+
51+
[docs-badge]: https://img.shields.io/badge/docs-built-blue
52+
[docs-url]: https://daboross.gitbook.io/screeps-starter-python/overview/setup

0 commit comments

Comments
 (0)