Permalink
Browse files

added README file to release. moved build libs to build folder for cl…

…arity.
  • Loading branch information...
1 parent 7cd28bd commit c5b9fba29fb3c36a9efa9b4e59e6c1966d354e8f @joelhooks joelhooks committed Oct 30, 2009
View
@@ -1,12 +1,24 @@
#Properties file for build.xml
-ver.num=v1.0RC1
-output.swc.name=robotlegs-framework
+project.name=robotlegs-framework
+
+#Version number for current Robotlegs and SwiftSuspenders releases
+robotlegs.ver.num=v1.0RC1
+swift.suspenders.version=v1.0RC1
+
+#build locations
asdoc.loc=${sdk.loc}/bin/asdoc
main.src.loc=${basedir}/src
test.src.loc=${basedir}/test
doc.loc=${basedir}/doc
-lib.loc=${basedir}/libs
+lib.loc=${basedir}/build/libs
bin.loc=${basedir}/bin
report.loc=${basedir}/report
dist.loc=${basedir}/dist
+template.loc=${basedir}/build/templates
+
+#Project links
+swift.suspenders.link=http://github.com/tschneidereit/SwiftSuspenders
+robotlegs.project.link=http://github.com/robotlegs/robotlegs-framework
+robotlegs.faq.link=http://knowledge.robotlegs.com
+robotlegs.best.practices.link=http://wiki.github.com/robotlegs/robotlegs-framework/best-practices
View
@@ -15,9 +15,6 @@
<target name="clean">
<!-- Remove all directories created during the build process -->
<delete includeemptydirs="true" failonerror="false">
- <fileset dir="${bin.loc}" defaultexcludes="false">
- <include name="**/*" />
- </fileset>
<fileset dir="${report.loc}" defaultexcludes="false">
<include name="**/*" />
</fileset>
@@ -37,17 +34,19 @@
<target name="compile" depends="init">
<echo>using Flex SDK at: ${FLEX_HOME}</echo>
- <!-- it won't let me use ${output.swc.name} here for some reason :/ -->
- <compc output="${bin.loc}/robotlegs-framework-${ver.num}.swc" incremental="true">
+ <!-- it won't let me use ${project.name} here for some reason :/ -->
+ <compc output="${bin.loc}/robotlegs-framework-${robotlegs.ver.num}.swc" incremental="true" static-link-runtime-shared-libraries="true">
<!-- include our Class packages into the build (com folder) -->
<include-sources dir="${main.src.loc}/org" includes="*" />
<library-path dir="${lib.loc}" append="true">
<include name="*.swc" />
</library-path>
<compiler.verbose-stacktraces>true</compiler.verbose-stacktraces>
<compiler.headless-server>true</compiler.headless-server>
+
+ <keep-as3-metadata name="Inject"/>
</compc>
- <echo>SWC ${output.swc.name}-${ver.num}.swc created successfully</echo>
+ <echo>SWC ${project.name}-${robotlegs.ver.num}.swc created successfully</echo>
</target>
<target name="test" depends="compile" >
@@ -83,22 +82,44 @@
<echo>ASDOC created successfully</echo>
</target>
+
<target name="package" depends="test">
+ <tstamp>
+ <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa" unit="hour"/>
+ </tstamp>
<!-- Assemble -->
<echo>Packaging Release</echo>
<mkdir dir="${dist.loc}" />
<mkdir dir="${dist.loc}/bin" />
<mkdir dir="${dist.loc}/src" />
- <copy file="${bin.loc}/${output.swc.name}-${ver.num}.swc" todir="${dist.loc}/bin" />
+ <copy file="${bin.loc}/${project.name}-${robotlegs.ver.num}.swc" todir="${dist.loc}/bin" />
<copy todir="${dist.loc}/src/org">
<fileset dir="${main.src.loc}/org"/>
</copy>
+ <!-- Copy README -->
+ <copy file="${template.loc}/README.tmpl"
+ tofile="${dist.loc}/README"
+ overwrite="true" >
+ <filterchain>
+ <replacetokens>
+ <token key="date" value="${touch.time}" />
+ <token key="rlversion" value="${robotlegs.ver.num}" />
+ <token key="releasename" value="${project.name}-${robotlegs.ver.num}" />
+ <token key="ssversion" value="${swift.suspenders.version}" />
+ <token key="sslink" value="${swift.suspenders.link}" />
+ <token key="rlprojectlink" value="${robotlegs.project.link}" />
+ <token key="bestpracticeslink" value="${robotlegs.faq.link}" />
+ <token key="faqlink" value="${robotlegs.best.practices.link}" />
+ </replacetokens>
+ </filterchain>
+ </copy>
<!-- Zip It -->
- <zip destfile="${dist.loc}/${output.swc.name}-${ver.num}.zip">
+ <zip destfile="${dist.loc}/${project.name}-${robotlegs.ver.num}.zip">
<fileset dir="${dist.loc}" />
</zip>
<!-- Clean Up -->
- <delete file="${dist.loc}/${output.swc.name}-${ver.num}.swc"/>
+ <delete file="${dist.loc}/${project.name}-${robotlegs.ver.num}.swc"/>
+ <delete file="${dist.loc}/README"/>
<delete dir="${dist.loc}/bin"/>
<delete dir="${dist.loc}/src"/>
</target>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -0,0 +1,36 @@
+Robotlegs AS3 Micro-Architecture @rlversion@
+built on @date@
+
+INSTALLATION
+This distribution of Robotlegs AS3 Micro-Architecture is distributed with the binary SWC file (@releasename@.swc).
+The SWC file should be enough to get started. Simply drop it in your projects libs folder (or wherever you keep
+external libraries) and you will have access to the fully functioning framework.
+
+BUILDING
+In addition to the SWC file in this distribution package, the Robotlegs AS3 Micro-Architecture v@rlversion@ source code
+is also provided. This source code is dependent on the SwiftSuspenders @ssversion@ library to function properly.
+This library can be found at: @sslink@
+
+If you would prefer to build from the source, it is highly recommended that you download the Robotlegs AS3 Micro-Architecture
+project in its entirety. This project contains all of the required libraries and ANT build scripts to generate SWC
+files of the framework. This project can be found at: @rlprojectlink@
+
+USAGE
+Please refer to the Best Practices documentation for an introduction to using the Robotlegs AS3 Micro-Architecture.
+Additionally there is a knowledge base/FAQ where you can ask questions and receive support.
+
+Best Practices: @bestpracticeslink@
+Knowledge Base/FAQ: @faqlink@
+
+LICENSE
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -16,13 +16,11 @@
private function onCreationComplete():void
{
core = new FlexUnitCore();
- core.addListener(new UIListener(uiListener));
core.addListener(new CIListener());
core.run(RobotLegsTestSuite);
}
]]>
</mx:Script>
- <fu:TestRunnerBase id="uiListener"/>
</mx:Application>

0 comments on commit c5b9fba

Please sign in to comment.