add initial readme and release notes
Project: http://git-wip-us.apache.org/repos/asf/flex-utilities/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-utilities/commit/3c6863c4 Tree: http://git-wip-us.apache.org/repos/asf/flex-utilities/tree/3c6863c4 Diff: http://git-wip-us.apache.org/repos/asf/flex-utilities/diff/3c6863c4 Branch: refs/heads/develop Commit: 3c6863c43c78b2c35b3f2a34ce8627574faf0805 Parents: 47a594e Author: Justin Mclean <[email protected]> Authored: Thu Aug 28 10:55:10 2014 +1000 Committer: Justin Mclean <[email protected]> Committed: Thu Aug 28 10:55:10 2014 +1000 ---------------------------------------------------------------------- Squiggly/README | 57 +++++++++++++++++++++++++++++++++++++++++++++ Squiggly/RELEASE_NOTES | 7 ++++++ 2 files changed, 64 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-utilities/blob/3c6863c4/Squiggly/README ---------------------------------------------------------------------- diff --git a/Squiggly/README b/Squiggly/README new file mode 100644 index 0000000..ad06111 --- /dev/null +++ b/Squiggly/README @@ -0,0 +1,57 @@ + + The Apache Flex Squiggly is a ActionScript spell checking library. + + This application is based on work donated by Adobe. + +========================================================================================== +Initial Setup Required +========================================================================================== + + FLEX_HOME is the absolute path to the Apache Flex SDK + If you omit this argument, and the system environment variable, FLEX_HOME exists, + it is used. + +========================================================================================== +How to build the installer using ant (no IDE is required) +========================================================================================== + +1. On Linux or Mac un tar/gzip the source distribution: + tar -zxvf apache-flex-squiggly-1.0.tar.gz + Or if on windows unzip + apache-flex-squiggly-1.0.zip + +2. In the base directory, run: + ant compile + +3. To optionally create a release source package, run: + ant package + +4. The compiled swcs can be found in the main/libs directory + +5. To remove all of the compiled swcs: + ant clean + +========================================================================================== +Some other useful ant targets +========================================================================================== + +There are several other useful ant targets. + + compile-swc compile squiggly swcs + package package up all source files + package-binary-tar tar up all source files and swcs + package-binary-zip zip up all source files and swcs + package-source-tar tar up all source files + package-source-zip zip up all source files + +========================================================================================== +How to check the code out of Git +========================================================================================== + +1. Check out the the code from the Apache Flex utilities project + git clone https://git-wip-us.apache.org/repos/asf/flex-utilities.git flex-utilities + cd flex-utilities + git checkout develop + +2. Change directory to: + cd Squiggly http://git-wip-us.apache.org/repos/asf/flex-utilities/blob/3c6863c4/Squiggly/RELEASE_NOTES ---------------------------------------------------------------------- diff --git a/Squiggly/RELEASE_NOTES b/Squiggly/RELEASE_NOTES new file mode 100644 index 0000000..a4ae170 --- /dev/null +++ b/Squiggly/RELEASE_NOTES @@ -0,0 +1,7 @@ +------------------------------------------------ +Squiggly 1.0 +------------------------------------------------ + +Initial parity release for Adobe's Squiggly library. + +Note that the ANE version of Squiggly may be added in a future release. \ No newline at end of file
