This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/develop by this push:
new e4023a8 fill out get started
e4023a8 is described below
commit e4023a8cec0f5a468818e3aed80548d55ee8b753
Author: Alex Harui <aha...@apache.org>
AuthorDate: Tue Feb 13 13:11:12 2018 -0800
fill out get started
---
Get Started.md | 14 +++++-
Welcome/Get_Started/Development-tools.md | 26 ++++++----
Welcome/Get_Started/Download-Royale.md | 76 +++++++++++++++++++++++++++++
Welcome/Get_Started/Frameworks.md | 33 +++++++++++++
Welcome/Get_Started/Hello-World.md | 82 ++++++++++++++++++++++++++++++++
_data/toc.json | 10 ++--
6 files changed, 225 insertions(+), 16 deletions(-)
diff --git a/Get Started.md b/Get Started.md
index b12f0c3..ecafde3 100644
--- a/Get Started.md
+++ b/Get Started.md
@@ -20,4 +20,16 @@ title: Get Started
# Get started with Royale
-*This information will be available soon.*
+Royale is an open source project. You can get the [source
code](http://royale.apache.org/source-code/){:target='_blank'} and build
Royale, or, if you are in a hurry, you can click
[here](Welcome/Get_Started/Download-Royale.html) to find out how to download
pre-compiled code and get going quickly.
+
+This section describes:
+
+[System Requirements](Welcome/Get_Started/System-Requirements.html) - What
kinds of computers and operating systems you can use to develop Royale
applications. You can run Royale applications on many more computers,
operating systems and even devices such as smartphones and tablets.
+
+[Development Tools](Welcome/Get_Started/Development-tools.html) - You can
develop Royale with just the command-line, or you can use scripting/build tools
like Apache Ant and Apache Maven, or even use IDEs.
+
+[Frameworks](Welcome/Get_Started/frameworks.html) - What popular JavaScript
frameworks can be used in Royale Applications.
+
+[Download Royale](Welcome/Get_Started/Download-Royale.html) - How to download
and set up Royale.
+
+[Hello World](Welcome/Get_Started/Hello-World.html) - Build Hello World in
Royale.
diff --git a/Welcome/Get_Started/Development-tools.md
b/Welcome/Get_Started/Development-tools.md
index dd44a74..24f2cbf 100644
--- a/Welcome/Get_Started/Development-tools.md
+++ b/Welcome/Get_Started/Development-tools.md
@@ -20,35 +20,41 @@ title: Development tools
# Development tools
-*text coming soon*
+You can just use and standard text editor to write Royale applications and the
command-line to compile them, but you may find that an Interactive Development
Environment (IDE) can make you even more productive.
## IDEs
IDEs that support Apache Royale provide getting-started instructions to help
you specify using Royale for a new project, or importing an existing Royale
project.
-- Visual Studio
+### IDEs with Royale support
-- Moonshine
+- [Visual Studio Code with ActionScript and MXML
Extensions](https://github.com/BowlerHatLLC/vscode-nextgenas/wiki/Install-the-ActionScript-and-MXML-extension-for-Visual-Studio-Code){:target='_blank'}
-- Flash Builder
+- [Moonshine](http://moonshine-ide.com){:target='_blank'}
-- IntelliJ IDEA
+### IDES that supported Flex and work with Royale with some restrictions and
limitations.
-- FDT
+- Adobe Flash Builder
+- IntelliJ IDEA
+- FDT
-*more text and links coming*
+- Flash Develop
## Command-line scripts
-*text coming*
+To run the compiler, run the js/bin/mxmlc tool in the Royale SDK. The
[Download Royale](Welcome/Get_Started/Download-Royale.html) and [Hello
World](Welcome/Get_Started/Hello-World.html) sections provide an example of how
to use the compiler.
## Apache Maven
-*Maven-related text and links coming.*
+You can use Apache Maven to compile your Royale application. The Royale
documentation will not describe what Maven is and how to use it. Visit the
[Apache Maven Project](http://maven.apache.org){:target='_blank'} to learn more
about Maven. Each of the examples in the examples folder is set up to be built
with Maven, and the archetypes folder contains Maven Archetypes.
+
+## Apache Ant
+
+You can use Apache Ant to compile your Royale application. The Royale
documentation will not describe what Ant is and how to use it. Visit the
[Apache Ant Project](http://ant.apache.org){:target='_blank'} to learn more
about Ant. Each of the examples in the examples folder is set up to be built
with Ant.
## Apache Cordova
-*Text coming on packaging an app for mobile phones*
+Apache Cordova enables Royale applications to run on mobile devices, tablets,
and even desktops. The MobileTrader example in examples/royale/MobileTrader
and a few other examples use Cordova.
diff --git a/Welcome/Get_Started/Download-Royale.md
b/Welcome/Get_Started/Download-Royale.md
new file mode 100644
index 0000000..edcdd86
--- /dev/null
+++ b/Welcome/Get_Started/Download-Royale.md
@@ -0,0 +1,76 @@
+---
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+layout: docpage
+title: Download Royale
+---
+
+# Download Royale
+
+You can download Apache Royale via Node Package Manager (NPM) or from mirrors
of Apache releases. NPM is simpler.
+
+## NPM
+
+To use NPM to install Royale, use the following command line for your
operating system.
+
+### Mac
+
+```
+sudo npm install @apache-royale/royale-js -g
+```
+### Windows
+
+```
+npm install @apache-royale/royale-js -g
+```
+
+If you want SWF output as well as JavaScript output, install these packages
instead.
+
+### Mac
+
+```
+sudo npm install @apache-royale/royale-js-swf -g
+```
+### Windows
+
+```
+npm install @apache-royale/royale-js-swf -g
+```
+
+If the install completes successfully, you are ready to compile your
application with Royale by using the mxmlcnpm tool from the command-line. The
NPM install should have put mxmlcnpm in your path.
+
+## Apache Mirrors
+
+Use the following links to get a choice of mirrors to use for your download.
+
+[tar.gz (for
Mac)](http://www.apache.org/dyn/closer.lua/royale/0.9.1/binaries/apache-royale-0.9.1-bin-js.tar.gz){:target='_blank'}
+
+[zip (for
Windows)](http://www.apache.org/dyn/closer.lua/royale/0.9.1/binaries/apache-royale-0.9.1-bin-js.zip){:target='_blank'}
+
+
+If you want SWF output as well as JavaScript output, download one of these
packages instead.
+
+[tar.gz (for
Mac)](http://www.apache.org/dyn/closer.lua/royale/0.9.1/binaries/apache-royale-0.9.1-bin-js-swf.tar.gz){:target='_blank'}
+
+[zip (for
Windows)](http://www.apache.org/dyn/closer.lua/royale/0.9.1/binaries/apache-royale-0.9.1-bin-js-swf.zip){:target='_blank'}
+
+Once downloaded, uncompress the file into a folder somewhere. This folder
will be referred to as the SDK folder throughout the documentation. If you
chose the package with SWF support, you will need to follow the instructions in
the README to install libraries from Adobe System Inc or use the Apache Ant
script InstallAdobeSDKs.xml by running from the SDK folder:
+
+```
+ant -f InstallAdobeSDKs.xml
+```
+
+At this point, you should be able to run the js/bin/mxmlc compiler from your
Royale SDK folder to compile a Royale application. See the [Hello
World](Welcome/Get_Started/Hello-World.html) section for more details.
diff --git a/Welcome/Get_Started/Frameworks.md
b/Welcome/Get_Started/Frameworks.md
new file mode 100644
index 0000000..a03ab18
--- /dev/null
+++ b/Welcome/Get_Started/Frameworks.md
@@ -0,0 +1,33 @@
+---
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+layout: docpage
+title: Frameworks
+---
+
+# Frameworks
+
+A framework is a set of code that provides support for application development
by offering templates, components and examples. Royale provides its own
framework for making simple, small and fast applications, but also offers
support for using other popular JavaScript frameworks. Why would you use
Royale with a third-party framework? Because you like the look and feel of
that framework's user interface components but want to use ActionScript to
handle the business logic and/or use MXML [...]
+
+Royale supports (to varying degrees):
+
+- [Material Design Lite](https://getmdl.io){:target='_blank') Most, if not
all, components are available
+
+- [JQuery UI](https://jqueryui.com){:target='_blank') Only a few components
are available. Volunteers are needed to support more components. Note that
this does not mean that you write actual JQuery queries in your application
source code, it just means that you can use the user interface controls to get
the same user experience as JQuery apps.
+
+- [CreateJS](https://www.createjs.com){:target='_blank') Only a few
components are available. Volunteers are needed to support more components.
+
+Many other JavaScript frameworks could be made to work with Royale if they
support dynamic instantiation of components. All it takes is volunteers to
make it happen.
diff --git a/Welcome/Get_Started/Hello-World.md
b/Welcome/Get_Started/Hello-World.md
new file mode 100644
index 0000000..33d874c
--- /dev/null
+++ b/Welcome/Get_Started/Hello-World.md
@@ -0,0 +1,82 @@
+---
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+layout: docpage
+title: Hello World
+---
+
+# Hello World
+
+To verify that the Royale SDK is set up correctly, it is recommended to create
and build a "Hello World" example. If that works, you can move on to the
["Create an Application"](Create%20An%20Application.html) section and work
through the tutorial on building a more substantial application.
+
+## Create the project folders
+
+Create or select a folder to hold this application's source and output.
+
+In that folder, create a folder called "HelloWorld" (it can be named something
else if you want and can contain spaces). This folder will be referred to as
the "project" folder throughout the documentation.
+
+In the project folder, create a folder called src. You can use other names,
but the compiler will manage your output folders for you if you use "src" or
"src/main/royale" ("src\main\royale" on Windows).
+
+So, if you used a folder called "Projects" for all of your project folders,
then you would have the following folders:
+
+```
+Projects
+Projects/HelloWorld
+Projects/HelloWorld/src
+```
+
+## Create the source file
+
+In the src folder, create a file called HelloWorld.mxml and use your favorite
text editor to give that file the following contents:
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<js:Application xmlns:fx="http://ns.adobe.com/mxml/2009";
+ xmlns:js="library://ns.apache.org/royale/express">
+
+ <js:initialView>
+ <js:View>
+ <js:Label text="Hello World" />
+ </js:View>
+ </js:initialView>
+</js:Application>
+```
+
+## Compile the source file
+
+If you used NPM to install Royale, run from your project folder:
+
+```
+ mxmlcnpm src/HelloWorld.mxml
+```
+
+If you didn't use NPM, run:
+
+```
+ <path to SDK folder>/js/binmxmlc src/HelloWorld.mxml
+```
+
+## Run the output
+
+If the compiler reported success, there should be a bin/js-release output
folder in your project folder, such as
+
+```
+ Projects/HelloWorld/bin/js-release
+```
+
+In there should be an index.html file you can open in your browser and you
should see "Hello World" in your browser. If you see that, congratulations!
You have installed Royale successfully and are ready to build Royale
applications. The ["Create an Application"](Create%20An%20Application.html)
contains a tutorial for building a more substantial application.
+
+
diff --git a/_data/toc.json b/_data/toc.json
index 5b130fd..2511812 100644
--- a/_data/toc.json
+++ b/_data/toc.json
@@ -19,11 +19,11 @@
]
},
{"path" : "Get Started.md",
- "children" : [{"path" : "GetStarted/System Requirements.md" },
- {"path" : "GetStarted/Development Tools.md" },
- {"path" : "GetStarted/Frameworks.md" },
- {"path" : "GetStarted/Download Royale.md" },
- {"path" : "GetStarted/Hello World.md" }
+ "children" : [{"path" :
"Welcome/Get_Started/System-Requirements.md" },
+ {"path" : "Welcome/Get_Started/Development-tools.md"
},
+ {"path" : "Welcome/Get_Started/Frameworks.md" },
+ {"path" : "Welcome/Get_Started/Download-Royale.md" },
+ {"path" : "Welcome/Get_Started/Hello-World.md" }
]
},
{"path" : "Create An Application.md",
--
To stop receiving notification emails like this one, please contact
aha...@apache.org.
