Skip to content

Commit 94f8d67

Browse files
committed
README: clarifications and improvements
1 parent 1ada1c5 commit 94f8d67

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

+29-27
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,47 @@ Starling Framework
66
The Cross Platform Game Engine
77
------------------------------
88

9-
The Starling Framework allows you to create hardware accelerated apps in ActionScript 3, Haxe, TypeScript or JavaScript. The main target is the creation of 2D games, but Starling may be used for any graphical application. Thanks to Adobe AIR, Starling-based applications can be deployed to mobile devices (iOS, Android), the desktop (Windows, OS X), and to the browser (via the Flash plugin).
9+
The Starling Framework allows you to create hardware accelerated apps in Haxe, TypeScript, JavaScript, or ActionScript 3. The main target is the creation of 2D games, but Starling may be used for any graphical application. Thanks to OpenFL, Starling-based applications can be deployed to mobile devices (iOS, Android), the desktop (Windows, macOS, Linux), and to web browsers via either JavaScript or WebAssembly.
1010

11-
You can also pair Starling with OpenFL to deploy native builds for iOS, Android, Windows, OS X, Linux or WebAssembly, as well as Flash/AIR or regular HTML5 releases without WebAssembly. HTML5 support is available in TypeScript, Haxe, ES5 JavaScript or ES6+ JavaScript.
12-
13-
While Starling mimics the classic display tree architecture of Adobe AIR/Flash, it provides much better performance than the Adobe version: all objects are rendered directly by the GPU (using the Stage3D API). When paired with OpenFL, Starling provides an alternative GPU renderer with helpful features. The complete architecture was designed for working well with the GPU; common game development tasks were built right into its core. Starling hides Stage3D internals from developers, but makes it easy to access them for those who need full performance and flexibility.
11+
While Starling mimics the classic display tree architecture of OpenFL, it provides much better performance than the OpenFL version: all objects are rendered directly by the GPU (using the Stage3D API) with improved batching and support for things like texture atlases. When paired with OpenFL, Starling provides an alternative GPU renderer with helpful features. The complete architecture was designed for working well with the GPU; common game development tasks are built right into its core. Starling hides Stage3D internals from developers who don't need low-level access, but makes it easy to access them for those who need full performance and flexibility.
1412

1513
Starling aims to be as lightweight and easy to use as possible. As an open-source project, much care was taken to make the source code easy to read, understand and extend. With under 15k lines of code, experienced developers can easily grasp it in its entirety, or modify it to their needs.
1614

1715
Getting Started (Haxelib)
1816
-------------------------
1917

20-
You can easily install Starling using haxelib:
18+
First, [install the Haxe toolkit](https://haxe.org/download).
19+
20+
Then, you can easily install Starling by running the following command in a terminal or command prompt:
2121

22-
haxelib install starling
22+
```sh
23+
haxelib install starling
24+
```
2325

24-
To add it to an OpenFL project, add this to your project file:
26+
To include Starling in an OpenFL project, add this line to your [_project.xml_](https://lime.openfl.org/docs/project-files/xml-format/) file:
2527

2628
```xml
2729
<haxelib name="starling" />
2830
```
2931

30-
You can also create a new empty project like this:
32+
You can also create a new empty project by running the following command:
3133

32-
```bash
34+
```sh
3335
openfl create starling:project StarlingProject
3436
```
3537

36-
You can also try the Starling demo:
38+
You can also try the Starling demo project:
3739

38-
```bash
40+
```sh
3941
openfl create starling:demo
4042
cd demo
41-
openfl test flash
43+
openfl test html5
4244
```
4345

4446
Getting Started (NPM)
4547
---------------------
4648

47-
You can install the Yeoman generator to create an empty project:
49+
To use Starling with TypeScript, JavaScript, or AS3 with Apache Royale, you can install the Yeoman generator to create an empty project:
4850

4951
```bash
5052
npm install -g yo starling-framework-generator
@@ -66,32 +68,32 @@ There are AS3, ES5, ES6, Haxe and TypeScript versions of the demo available.
6668

6769
Note about high-dpi support
6870
---------------------------
69-
Starling supports high-dpi devices such as 4K monitors
70-
For it to work you need to add this in your project file:
71+
72+
Starling supports high-dpi devices such as 4K monitors. To enable high-dpi, add this line to your project file:
73+
7174
```xml
7275
<window allow-high-dpi="true"/>
7376
```
74-
You also need to tell starling to support high resolutions in your code:
75-
```bash
77+
78+
You also need to set a flag in your code to tell Starling to support high resolutions:
79+
80+
```haxe
7681
starling.supportHighResolutions = true;
7782
```
7883

84+
Quick Links (Haxe)
85+
------------------
86+
87+
* [Starling Support Forum](https://forum.starling-framework.org/t/starling-haxe)
88+
* [OpenFL Support Forum](http://community.openfl.org)
89+
7990
Quick Links (AS3)
8091
-----------------
8192

8293
* [Official Homepage](http://www.starling-framework.org)
8394
* [Instruction Manual](http://manual.starling-framework.org)
8495
* [API Reference](http://doc.starling-framework.org)
85-
* [Support Forum](http://forum.starling-framework.org)
96+
* [Support Forum](https://forum.starling-framework.org/)
8697
* [Starling Wiki](http://wiki.starling-framework.org)
8798
* [Showcase](http://wiki.starling-framework.org/games/start)
8899
* [Extensions](http://wiki.starling-framework.org/extensions/start)
89-
* [OpenFL Support Forum](http://community.openfl.org)
90-
91-
News and Updates
92-
----------------
93-
94-
* [Twitter](https://twitter.com/gamua)
95-
* [Facebook](https://facebook.com/gamua.co)
96-
* [Google+](https://www.google.com/+gamua)
97-
* [LinkedIn](https://www.linkedin.com/company/gamua)

0 commit comments

Comments
 (0)