From 63b6247998be3272f2c41644233e2a17b17b07b1 Mon Sep 17 00:00:00 2001 From: Emiliano Angelini Date: Tue, 24 Apr 2012 09:56:41 -0300 Subject: [PATCH] Adding readme files again --- MailSender/README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 72 +++++++++++++++++++++++++++++++++++++ 2 files changed, 158 insertions(+) create mode 100644 MailSender/README.md create mode 100644 README.md diff --git a/MailSender/README.md b/MailSender/README.md new file mode 100644 index 0000000..efdcaf3 --- /dev/null +++ b/MailSender/README.md @@ -0,0 +1,86 @@ +**Haxe NME MailSender extension** + +This is a native extension for haxe NME which allows to call a native mail window. +(Currently iOS only) + +**Usage** + +Reference the extension in your .nmml: + + + +Reference the following iOS framework in your .nmml: + + + +Just call this static Method: + + MailSender.sendMail("MailSender sendMail sample", "Howdy, partner\n", false, "youremail@gmail.com", "youremail@gmail.com", "youremail@gmail.com"); + + Parameters: + ----------- + Subject:String + Body:String + isHTML:Boolean + to:String + cc:String + bcc:String + + +**Running the test application** + + cd Project + nme build MailSenderSample.nmml ios + + or + nme update MailSenderSample.nmml ios + + For the flash target a mailto: URL call is being used. + +**Recompiling the extension** + + cd Extension/project + haxelib run hxcpp Build.xml + + or + + haxelib run hxcpp Build.xml -DHXCPP_M64 + haxelib run hxcpp Build.xml -Diphoneos + haxelib run hxcpp Build.xml -Diphoneos -DHXCPP_ARMV7 + haxelib run hxcpp Build.xml -Diphonesim + haxelib run hxcpp Build.xml -Dwebos + haxelib run hxcpp Build.xml -Dandroid + haxelib run hxcpp Build.xml -Dblackberry + (depending on your target) + + +**License:** + +This extension and example license: + + Unless indicated otherwise, this code was created by Emiliano Angelini and + provided under a MIT-style license. + Copyright (c) Emiliano Angelini. All rights reserved. + + 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. + +The extension includes a copy of some classes from Apple's [MailComposer sample][1] (see license information in the relevant +files). + +[1]: http://developer.apple.com/library/ios/#samplecode/MailComposer/Introduction/Intro.html \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..47c6984 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +**NME extensions Repo** + +This is the place where I'll put all my NME extensions. + +Usually I'll add 2 folders for each extension (based on Joshua Granick's structure): +- Extension: Source and perhaps some compiled ones. +- Project: A sample NME project to quickly test the extension. + +**Usage** + +Reference the extension in your .nmml: + + + +Sometimes you'll have to also add a reference to some native framework in your .nmml. For instance: + + + +Find specific APIs for each extension inside their folders. + +**Running the test application** + + Go to the Project folder and run a build nme command for your desired nmml file. + + For instance: + cd Project + nme build MailSenderSample.nmml ios + + or + nme update MailSenderSample.nmml ios + +**Recompiling the extension** + + cd Extension/project + haxelib run hxcpp Build.xml + + or + + haxelib run hxcpp Build.xml -DHXCPP_M64 + haxelib run hxcpp Build.xml -Diphoneos + haxelib run hxcpp Build.xml -Diphoneos -DHXCPP_ARMV7 + haxelib run hxcpp Build.xml -Diphonesim + haxelib run hxcpp Build.xml -Dwebos + haxelib run hxcpp Build.xml -Dandroid + haxelib run hxcpp Build.xml -Dblackberry + (depending on your target) + +**License:** + +This extension and example license: + + Unless indicated otherwise, this code was created by Emiliano Angelini and + provided under a MIT-style license. + Copyright (c) Emiliano Angelini. All rights reserved. + + 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. \ No newline at end of file