Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
npm-flexjs: updated formatting in readme and fixed some typos
- Loading branch information
1 parent
ee771e6
commit 511bdcb
Showing
1 changed file
with
59 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,68 +1,84 @@ | ||
Apache FlexJS | ||
============= | ||
|
||
Apache FlexJS is a next-generation Flex SDK that has the goal of allowing | ||
applications developed in MXML and ActionScript to not only run in the | ||
Flash/AIR runtimes, but also to run natively in the browser without Flash, | ||
on mobile devices as a PhoneGap/Cordova application, and in embedded JS | ||
environments such as Chromium Embedded Framework. FlexJS has the potential | ||
to allow your MXML and ActionScript code to run in even more places than | ||
Flash currently does. | ||
Apache FlexJS is a next-generation Flex SDK that has the goal of allowing | ||
applications developed in MXML and ActionScript to not only run in the | ||
Flash/AIR runtimes, but also to run natively in the browser without Flash, | ||
on mobile devices as a PhoneGap/Cordova application, and in embedded JS | ||
environments such as Chromium Embedded Framework. FlexJS has the potential | ||
to allow your MXML and ActionScript code to run in even more places than | ||
Flash currently does. | ||
|
||
For detailed information about Apache Flex please visit the | ||
[FlexJS Wiki](https://s.apache.org/flexjs) | ||
For detailed information about Apache Flex please visit the | ||
[FlexJS Wiki](https://s.apache.org/flexjs) | ||
|
||
For detailed information about Apache Flex please visit the | ||
[Apache Flex Website] (http://flex.apache.org/) | ||
For detailed information about Apache Flex please visit the | ||
[Apache Flex Website](http://flex.apache.org/) | ||
|
||
Installation | ||
================================== | ||
|
||
Install the Apache FlexJS NPM Module globally | ||
Install the Apache FlexJS NPM Module globally | ||
|
||
npm install flexjs -g | ||
(There are a couple of prompts you need to answer before installation starts) | ||
|
||
(There are a couple of prompts you need to answer before installation starts) | ||
|
||
Usage | ||
================================== | ||
|
||
After global installation, the following compiler tools will be available for you | ||
to use: mxmlc, asjsc and asjscompc | ||
|
||
Usage: | ||
After global installation, the following compiler tools will be available for you | ||
to use: `mxmlc`, `compc`, `asjsc`, `asjscompc`, `asnodec`, and `externc`. | ||
|
||
Usage: | ||
|
||
mxmlc <path to main .mxml file> | ||
asjsc <path to main .as file> | ||
asjscompc <path to main .as file> | ||
|
||
|
||
Examples | ||
================================== | ||
|
||
There are several examples that ship with the FlexJS npm module. They are located in: | ||
Windows: C:\Users\<username>\AppData\Roaming\npm\node_modules\flexjs\examples\ | ||
Mac: /usr/local/lib/node_modules/flexjs/examples/ | ||
|
||
You can compile them with FlexJS like this: | ||
|
||
MXMLC (Targets apps built for the FlexJS SDK, which creats a swf file as well as | ||
HTML5/JavaScript output) | ||
|
||
Windows: mxmlc C:\Users\<username>\AppData\Roaming\npm\node_modules\flexjs\examples\flexjs\ChartExample\src\ChartExample.mxml | ||
Mac: mxmlc /usr/local/lib/node_modules/flexjs/examples/flexjs/ChartExample/src/ChartExample.mxml | ||
|
||
ASJSC (Write ActionScript3 targeting HTML5/SVG DOM without requiring JavaScript): | ||
|
||
Windows: asjsc C:\Users\<username>\AppData\Roaming\npm\node_modules\flexjs\examples\native\USStatesMap\src\USStatesMap.as | ||
Mac: asjsc /usr/local/lib/node_modules/flexjs/examples/native/USStatesMap/src/USStatesMap.as | ||
|
||
You may need to copy the examples to a writeable folder because the compilation | ||
will generate an output folder in the example folders. | ||
There are several examples that ship with the FlexJS npm module. They are located in: | ||
Windows: | ||
|
||
C:\Users\<username>\AppData\Roaming\npm\node_modules\flexjs\examples\ | ||
|
||
Mac: | ||
|
||
/usr/local/lib/node_modules/flexjs/examples/ | ||
|
||
You can compile them with FlexJS like this: | ||
|
||
MXMLC (Targets apps built for the FlexJS SDK, which creates a SWF file as well as | ||
HTML5/JavaScript output) | ||
|
||
Windows: | ||
|
||
mxmlc C:\Users\<username>\AppData\Roaming\npm\node_modules\flexjs\examples\flexjs\ChartExample\src\ChartExample.mxml | ||
|
||
Mac: | ||
|
||
mxmlc /usr/local/lib/node_modules/flexjs/examples/flexjs/ChartExample/src/ChartExample.mxml | ||
|
||
ASJSC (Write ActionScript3 targeting HTML5/SVG DOM without requiring JavaScript): | ||
|
||
Windows: | ||
|
||
asjsc C:\Users\<username>\AppData\Roaming\npm\node_modules\flexjs\examples\native\USStatesMap\src\USStatesMap.as | ||
|
||
Mac: | ||
|
||
asjsc /usr/local/lib/node_modules/flexjs/examples/native/USStatesMap/src/USStatesMap.as | ||
|
||
You may need to copy the examples to a writeable folder because the compilation | ||
will generate an output folder in the example folders. | ||
|
||
Note | ||
================================= | ||
|
||
Note: Apache Flex™, Flex, FlexJS and Apache™ are trademarks of The Apache Software Foundation. | ||
The Apache Flex SDK product page is located here: http://flex.apache.org | ||
Note: Apache Flex™, Flex, FlexJS and Apache™ are trademarks of The Apache Software Foundation. | ||
The Apache Flex SDK product page is located here: http://flex.apache.org | ||
|
||
Adobe Flash, Adobe AIR, and Adobe PhoneGap are either registered trademarks or trademarks | ||
of Adobe Systems Incorporated in the United States and/or other countries and are used by | ||
permission from Adobe. | ||
Adobe Flash, Adobe AIR, and Adobe PhoneGap are either registered trademarks or trademarks | ||
of Adobe Systems Incorporated in the United States and/or other countries and are used by | ||
permission from Adobe. |