This is an automated email from the ASF dual-hosted git repository.
joshtynjala pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
The following commit(s) were added to refs/heads/develop by this push:
new a05e085279 TourDeJewel: README should include build instructions
a05e085279 is described below
commit a05e08527923ca58224dc2cd093fc3535140851e
Author: Josh Tynjala <[email protected]>
AuthorDate: Mon Mar 24 15:18:19 2025 -0700
TourDeJewel: README should include build instructions
---
examples/jewel/TourDeJewel/README.txt | 37 ++++++++++++++++++++++++++++++-----
1 file changed, 32 insertions(+), 5 deletions(-)
diff --git a/examples/jewel/TourDeJewel/README.txt
b/examples/jewel/TourDeJewel/README.txt
index 4e7b0576b9..f55e28c614 100644
--- a/examples/jewel/TourDeJewel/README.txt
+++ b/examples/jewel/TourDeJewel/README.txt
@@ -21,11 +21,38 @@ DESCRIPTION
Tour De Jewel is a Component Explorer for Apache Royale Jewel UI Set
-Jewel is a new UI component set, created with design and responsiveness in
mind.
-Apache Royale provides themes to use with Jewel out of the box.
-Jewel themes support up to 12 colors, light/dark, and flat/normal modes.
+Jewel is a new UI component set for JavaScript, created with design and
+responsiveness in mind.
-This App shows all Jewel components and different use cases and is still in
development
-as we continue make it grow and improve.
+Apache Royale provides themes to use with Jewel out of the box. Jewel themes
+support up to 12 colors, light/dark, and flat/normal modes.
+This App shows all Jewel components and different use cases and is still in
+development as we continue make it grow and improve.
+HOW TO BUILD
+
+For convenience, this example includes build scripts, including a pom.xml file
+to build with Maven and a build.xml file to build with Ant.
+
+BUILD WITH MAVEN
+
+To build with Maven, run the following command in the project's root directory
+(which should be the same directory that contains this README file):
+
+ mvn compile
+
+The debug version of the app built with Maven can be found in the
+./target/javascript/bin/js-debug directory, and the optimized release version
of
+the app can be found in the ./target/javascript/bin/js-release directory.
+
+BUILD WITH ANT
+
+To build with Ant, run the following command in this project's root directory
+(which should be the same directory that contains this README file):
+
+ ant
+
+The debug version of the app built with Ant can be found in the ./bin/js-debug
+directory, and the optimized release version of the app can be found in the
+./bin/js-release directory.
