|
@@ -1 +1,68 @@
|
|
|
-See http://haxe.org
|
|
|
|
|
|
|
+
|
|
|
|
|
+# [Haxe - The Cross-Platform Toolkit](http://haxe.org)
|
|
|
|
|
+
|
|
|
|
|
+Haxe is an open source toolkit that allows you to easily build cross-platform tools and applications that target many mainstream platforms. The Haxe toolkit includes:
|
|
|
|
|
+
|
|
|
|
|
+ * **The Haxe programming language**, a modern, high-level, strictly-typed programming language
|
|
|
|
|
+ * **The Haxe cross-compiler**, a state-of-the-art, lightning-speed compiler for many targets
|
|
|
|
|
+ * **The Haxe standard library**, a complete, cross-platform library of common functionality
|
|
|
|
|
+
|
|
|
|
|
+Haxe allows you to compile for the following targets:
|
|
|
|
|
+
|
|
|
|
|
+ * C++
|
|
|
|
|
+ * C#
|
|
|
|
|
+ * Flash
|
|
|
|
|
+ * Java
|
|
|
|
|
+ * JavaScript
|
|
|
|
|
+ * NekoVM
|
|
|
|
|
+ * PHP
|
|
|
|
|
+
|
|
|
|
|
+You can try Haxe directly from your browser at http://try.haxe.org!
|
|
|
|
|
+
|
|
|
|
|
+For more information about Haxe, head to the [offical Haxe website](http://haxe.org).
|
|
|
|
|
+
|
|
|
|
|
+## License
|
|
|
|
|
+
|
|
|
|
|
+The Haxe project has several licenses, covering different parts of the projects.
|
|
|
|
|
+
|
|
|
|
|
+ * The Haxe compiler is released under the GNU General Public License version 2 or any later version.
|
|
|
|
|
+ * The Haxe libraries are released under a "two-clause" BSD license.
|
|
|
|
|
+ * The Neko runtime is licensed under the GNU Lesser General Public License version 2.1 or any later version.
|
|
|
|
|
+
|
|
|
|
|
+For the complete Haxe licenses, please see http://haxe.org/doc/license or doc/LICENSE.txt.
|
|
|
|
|
+
|
|
|
|
|
+## Installing Haxe
|
|
|
|
|
+
|
|
|
|
|
+The latest stable release is [Haxe v3.0](http://haxe.org/download). Pre-built binaries are available for your platform:
|
|
|
|
|
+
|
|
|
|
|
+ * **[Windows installer](http://haxe.org/file/haxe-3.0.0-win.exe)**
|
|
|
|
|
+ * **[OSX installer](http://haxe.org/file/haxe-3.0.0-osx-installer.dmg)**
|
|
|
|
|
+ * **[Linux 32-bit binaries](http://haxe.org/file/haxe-3.0.0-linux32.tar.gz)**
|
|
|
|
|
+ * **[Linux 64-bit binaries](http://haxe.org/file/haxe-3.0.0-linux64.tar.gz)**
|
|
|
|
|
+
|
|
|
|
|
+## Building from source
|
|
|
|
|
+
|
|
|
|
|
+ 1. Clone the repository using git. Be sure to initialize and fetch the submodules.
|
|
|
|
|
+
|
|
|
|
|
+ git clone git://github.com/HaxeFoundation/haxe.git
|
|
|
|
|
+ cd haxe
|
|
|
|
|
+ git submodule init
|
|
|
|
|
+ git submodule update
|
|
|
|
|
+
|
|
|
|
|
+ 2. Follow the [documentation on building Haxe for your platform](http://haxe.org/doc/build).
|
|
|
|
|
+
|
|
|
|
|
+## Using Haxe
|
|
|
|
|
+
|
|
|
|
|
+For information on on using Haxe, consult the [Haxe documentation]:
|
|
|
|
|
+
|
|
|
|
|
+ * [Haxe introduction](http://haxe.org/doc/intro), an introduction to the Haxe toolkit
|
|
|
|
|
+ * [Haxe language reference](http://haxe.org/ref), an overview of the Haxe programming language
|
|
|
|
|
+ * [Haxe API](http://haxe.org/api), a reference for the Haxe standard and native APIs
|
|
|
|
|
+ * [Haxelib](http://lib.haxe.org/), a repository of Haxe libraries for a variety of needs
|
|
|
|
|
+
|
|
|
|
|
+## Community
|
|
|
|
|
+
|
|
|
|
|
+The can get help and talk with fellow Haxers from around the world via:
|
|
|
|
|
+
|
|
|
|
|
+ * the [official Haxe Google Group](https://groups.google.com/forum/#!forum/haxelang)
|
|
|
|
|
+ * the [Haxe IRC chatroom](http://unic0rn.github.io/tiramisu/haxe/), #haxe on chat.freenode.net
|
Simon Krajewski