moonwalkair 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.markdown ADDED
@@ -0,0 +1,112 @@
1
+ # MoonwalkAIR: Easy way to create AIR apps with JS
2
+
3
+ MoonwalkAIR provides:
4
+
5
+ * binary to generate your app folder
6
+ * script to run your app
7
+ * script to build your air file
8
+ * script to create self signed certificate thats necessary to compile AIR apps
9
+
10
+ ## Why
11
+
12
+ I ([Daniel Lopes](http://areacriacoes.com.br)) started this project with main purpose to help me in the process of creating [Pomodo](http://pomodo.areacriacoes.com.br/) (an AIR app made with JS). This project avoid some repetitive decisions about organization and will help you to be more productive with boring tasks like run/compile your app without an IDE.
13
+ For now this project not try to be a framework or anything like that. If you like to use it and want help will be very wellcome.
14
+
15
+ ## Dependencies
16
+
17
+ * ruby
18
+ * rubygems
19
+ * air sdk
20
+
21
+ ## What is generated for you:
22
+
23
+ When you call moonwalk command it will generate a folder structure where you will start your app. The content is this:
24
+
25
+ <pre>
26
+ .
27
+ |-- LICENSE
28
+ |-- README
29
+ |-- app
30
+ | |-- assets
31
+ | | |-- audio
32
+ | | |-- css
33
+ | | | |-- jqtouch.css
34
+ | | | |-- test.css
35
+ | | | `-- theme.css
36
+ | | `-- images
37
+ | | |-- apple
38
+ | | `-- icons
39
+ | | |-- 128.png
40
+ | | |-- 16.png
41
+ | | |-- 32.png
42
+ | | `-- 48.png
43
+ | |-- lib
44
+ | | |-- air
45
+ | | |-- jquery.js
46
+ | | `-- plugins
47
+ | | `-- jqtouch
48
+ | | |-- jqtouch.js
49
+ | | `-- jqtouch.transitions.js
50
+ | |-- scripts
51
+ | `-- views
52
+ | `-- index.html
53
+ |-- bin
54
+ |-- config
55
+ | |-- boot.rb
56
+ | |-- build.yml
57
+ | |-- config.yml
58
+ | `-- update_config.xml
59
+ |-- descriptor.xml
60
+ `-- script
61
+ |-- build
62
+ |-- certificate
63
+ `-- run
64
+ </pre>
65
+
66
+ ## Installing
67
+
68
+ gem install moonwalkair
69
+
70
+ ## Using
71
+
72
+ ### Creating your app
73
+
74
+ It's easy to get up and running, just run the follow command to get all folders and files in the right place.
75
+
76
+ moonwalk my_app
77
+
78
+ ### AIR SDK
79
+
80
+ After generate your app you need to point what is your AIR SDK path in "my_app/config/config.yml"
81
+
82
+ ### Certificates
83
+
84
+ AIR apps need a certificate to be compiled, for development and tests purpose you can create a self signed certificate with the following command:
85
+
86
+ script/certificate -p your_password
87
+
88
+ ### Running
89
+
90
+ Now you can run your APP with:
91
+
92
+ script/run
93
+
94
+ ### Building
95
+
96
+ To build your app you should have a certificate file in config, after that just call the following command and type your password. This command also minify and obfuscate all your css and js files.
97
+
98
+ script/build
99
+
100
+ ## Developing your APP
101
+
102
+ By default your folder will be created with jQuery and jQtouch (all animations will work if you use AIR 2.0 Beta) but you can use any other JS Library.
103
+ Just remove default folder inside "my_app/app" folder and place your prefered JS files, you also need to update "my_app/config/build.yml".
104
+ Now everytime you call script/run or script/build it will load the correct files.
105
+
106
+ AIR apps depends of a descriptor file, inside the "my_app/descriptor.xml" you can define things like window size, chrome, app name and etc. Open this file and customize it at your taste.
107
+
108
+ You will work most of time in app folder and only thing you need to know is HTML/CSS and Javascript. You will also need to know how AIR api works, and recommend these links:
109
+
110
+ * [Adobe AIR 1.5](http://help.adobe.com/en_US/AIR/1.5/devappshtml/index.html)
111
+ * [Adobe AIR language reference](http://help.adobe.com/en_US/AIR/1.5/jslr/)
112
+ * [Adobe AIR Developer center](http://www.adobe.com/devnet/air/ajax/quickstart/)
data/VERSION.yml CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
- :minor: 1
3
2
  :patch: 0
4
3
  :major: 0
4
+ :minor: 2
5
5
  :build:
data/moonwalkair.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{moonwalkair}
8
- s.version = "0.1.0"
8
+ s.version = "0.2.0"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Daniel Lopes"]
@@ -16,13 +16,13 @@ Gem::Specification.new do |s|
16
16
  s.executables = ["moonwalk"]
17
17
  s.extra_rdoc_files = [
18
18
  "LICENSE",
19
- "README.rdoc"
19
+ "README.markdown"
20
20
  ]
21
21
  s.files = [
22
22
  ".document",
23
23
  ".gitignore",
24
24
  "LICENSE",
25
- "README.rdoc",
25
+ "README.markdown",
26
26
  "Rakefile",
27
27
  "VERSION.yml",
28
28
  "bin/moonwalk",
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: moonwalkair
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel Lopes
@@ -30,12 +30,12 @@ extensions: []
30
30
 
31
31
  extra_rdoc_files:
32
32
  - LICENSE
33
- - README.rdoc
33
+ - README.markdown
34
34
  files:
35
35
  - .document
36
36
  - .gitignore
37
37
  - LICENSE
38
- - README.rdoc
38
+ - README.markdown
39
39
  - Rakefile
40
40
  - VERSION.yml
41
41
  - bin/moonwalk
data/README.rdoc DELETED
@@ -1,17 +0,0 @@
1
- = moonwalkair
2
-
3
- Description goes here.
4
-
5
- == Note on Patches/Pull Requests
6
-
7
- * Fork the project.
8
- * Make your feature addition or bug fix.
9
- * Add tests for it. This is important so I don't break it in a
10
- future version unintentionally.
11
- * Commit, do not mess with rakefile, version, or history.
12
- (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
13
- * Send me a pull request. Bonus points for topic branches.
14
-
15
- == Copyright
16
-
17
- Copyright (c) 2009 Daniel Lopes. See LICENSE for details.