This is an automated email from the ASF dual-hosted git repository.
andreww 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 0a480f3 Update application-structure.md
0a480f3 is described below
commit 0a480f339ad23706d19e992437562603bb526ad4
Author: Andrew Wetmore <and...@cottage14.com>
AuthorDate: Wed Jan 31 13:25:52 2018 -0400
Update application-structure.md
Added material distinguishing between creating a project with an IDE or
when using command-line or Maven.
---
create-an-application/application-structure.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/create-an-application/application-structure.md
b/create-an-application/application-structure.md
index 554b8a4..f3c3a1c 100644
--- a/create-an-application/application-structure.md
+++ b/create-an-application/application-structure.md
@@ -22,15 +22,17 @@ title: Application structure
Royale applications are usually comprised of many files. If you are in
rapid-prototyping or proof-of-concept "get something small running quickly"
mode, you can cram everything into one file. But breaking things into multiple
pieces often helps you organize or create "separation of concerns", and as your
project and team grows, you and your teammates can work on individual pieces
independently without stepping on each other's work. Finally, coherent pieces
that perform some standard func [...]
-There are multiple popular ways of dividing up an Application into pieces:
Model-View (MV), Model-View-Controller (MVC), and other alphabet soup like MVP,
MVVM, HMVC and more. This documentation will not address these patterns in
detail. You can read more about them on the internet.
+There are multiple popular ways of dividing an Application into coherent and
reusable pieces: Model-View (MV), Model-View-Controller (MVC), and other
alphabet soup like MVP, MVVM, HMVC and more. This documentation will not
address these patterns in detail. You can read more about them on the internet.
Whatever you decide for how many files you will have, another thing to keep in
mind is that Royale can produce different kinds of output, like SWFs for Adobe
FlashPlayer or Adobe AIR as well as HTML/JS/CSS for browsers and Apache Cordova
applications. So, the recommended practice is to create a folder for your
project files and a set of subfolders within it. The Royale compiler detects
certain common folder patterns and automatically chooses where to put output
folders, although you can [...]
-Let's say you are creating a project called MyFirstRoyaleApp. Create a
MyFirstRoyaleApp folder and in it create a folder named "src" and put your
source code in there. If you do that, the compiler will put the output in a
"bin" folder".
+If you are using an IDE that supports Royale, it will create the standard
folder structure for you when you create a Royale project. If you are working
outside of an IDE, and perhaps using command-line instructions to compile your
code, here is how to structure your project.
-If you are going to use Apache Maven to build your app, you can use one of the
Maven archetypes, which put the main application source code 3 levels deep in a
"src/main/royale" folder tree. Other kinds of files then go in
"src/main/resource", "src/main/config" and more. Maven will instruct the
compiler to put the output in a "target/javascript/bin" folder tree.
+Let's say you are creating a project called MyFirstRoyaleApp. Create a
MyFirstRoyaleApp folder and in it create a folder named "src". Put your source
code in there. If you do that, the compiler will put the output in a "bin"
folder that it creates.
-Most Royale applications use an MXML file as the main application file. Other
files are written in MXML or ActionScript depending on whether you are
assembling pieces or writing custom logic. You can write a Royale Application
without using MXML at all, but you'll end up writing more code.
+If you use <a href="https://maven.apache.org/"; target="_blank">Apache
Maven</a> to build your app, you can use one of the Maven archetypes, which put
the main application source code 3 levels deep in a "src/main/royale" folder
structure. Other kinds of files then go in "src/main/resource",
"src/main/config" and so on. Maven instructs the compiler to put the output in
a "target/javascript/bin" folder.
+
+Most Royale applications use an [MXML](Welcome/Features/MXML.html) file as the
main application file. Other files are written in MXML or
[ActionScript](Welcome/Features/AS3.html) depending on whether you are
assembling pieces or writing custom logic. You can write a Royale Application
without using MXML at all, but you'll end up writing more code.
So, if you decide to use MXML as your main application file, then your folder
structure might look like this:
--
To stop receiving notification emails like this one, please contact
andr...@apache.org.
