susanoo 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b70dbf48109146268832b75a63b0f5fb69360b26
-  data.tar.gz: d39ce476d21f2b284c4b08b7c43027d3f6c648aa
+  metadata.gz: e5b4783d4a9a26aecdee7e104d4eb88784ac8c4a
+  data.tar.gz: 94c2770a694ff736bcaff1d4a76d16f98ccf18c9
 SHA512:
-  metadata.gz: 4a24b04b291fdd00ebc0359fb82742fa4ec308b702cd5fa63b8dd999915eeaa9e566a91c1e0e2aaa2cdca277404c544a298822fe21ec8518e85370b1bbf73180
-  data.tar.gz: 94434fedeab4868194a06b1b8ae9d235409e8c2246f0172e47fa7b701a306f6c373881cd5aea96e1a33700bd3f56e656b7b1926ce23937d57f53e4ba3de795d5
+  metadata.gz: 476a04721d656adeaf18b42022327731427c444bd0bcc2deb50d30cd016acf70b79dda24e84e27f96da1cc270f354bf879a1c8d4ded115f568b6e43f975e02e0
+  data.tar.gz: 00bb42ff05dd1997626c8eaa38ba60c95f80846d5751cdcceaa60f3938d1f9d2e4f6a7a3104aeab2922378723e2ff014a049b5e05c3daec3d42dd4ad7e01ea15

data/docs/guide/installation.md

@@ -0,0 +1,18 @@
+# Installation
+`Susanoo`'s installation is fairly easy:
+
+```bash
+$ gem install susanoo
+```
+
+If you're not using ruby versions manager scripts like `rbenv` or `rvm` (which I totally recommend you to use
+`rbenv`) install `Susanoo` using `sudo` or `root` user.
+
+## Requirements
+
+Before contrinue make sure to install requirements of `Susanoo`. Here is the list:
+
+* NodeJS + npm
+* Install Apache Cordova using `npm` globally (version 3.5 or higher)
+* Target platform SDK. You have to install and setup the SDK of your target
+  platform (e.g android)

data/docs/guide/quick_start.md

@@ -0,0 +1,42 @@
+# Quick Start
+
+After [Installation]() of `Susanoo` head to you terminal to create a new project:
+
+```bash
+$ susanoo new example_project
+```
+
+Above command will ask you a few questions about your new project and download
+couple of files and the generate the new project for you.
+
+**Note:** You have to know about `Apache Cordova` basic usage to continue.
+
+ok now you have a `Susanoo` hello world application.
+
+## How can I run my new app ?
+Running a `Susanoo` application is easy too but you have to learn a little about
+the running process. In order to run you application you have to build it first
+(of caurse susanoo will do it automatically but it's a good idea to know about
+these stuff).
+
+Your code live at `src/` by default but `cordova` except a `www/` directory in your
+project, so by using:
+
+```bash
+$ susanoo build
+```
+
+You can compile your assets and ruby code to a static application (which `cordova`
+excepts) and put them in `www/` directory. There is an other command which allows
+you to run the built result:
+
+```bash
+$ susanoo run PLATFORM
+```
+
+will run the built resulted in given **PLATFORM** (NOTE: `run` will also run the
+`build` command too). Bear in mind that **YOU HAVE TO ALREADY INSTALLED YOU PLATFORM SDK BEFORE**
+so `run` command can find your **SDK** and run the project using that SDK.
+
+For example to run the application under `Android` platform you have to connect an android
+device or use some emulators like [genymotion](http://www.genymotion.com).

data/lib/susanoo/templates/application/.gitignore

@@ -1,3 +1,4 @@
+
 *~
 www/statics/*
 # ANDROID / ECLIPSE
@@ -48,4 +49,5 @@ IOS/www/
 
 # Files that might appear on external disk
 .Spotlight-V100
-.Trashes
+.Trashes
+www/

data/lib/susanoo/templates/application/Gemfile

@@ -5,4 +5,5 @@ gem 'pry'
 gem 'rerun'
 gem 'rack'
 gem 'rake'
-gem 'sprockets', '~>2.11.0'
+#gem 'sprockets', '2.11.0'
+#gem 'sass'

data/lib/susanoo/version.rb

@@ -1,3 +1,3 @@
 module Susanoo
-  VERSION = '0.7.2'
+  VERSION = '0.7.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: susanoo
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - Sameer Rahmani
@@ -238,6 +238,8 @@ files:
 - TODO.org
 - bin/susanoo
 - docs/guide/index.md
+- docs/guide/installation.md
+- docs/guide/quick_start.md
 - lib/susanoo.rb
 - lib/susanoo/application.rb
 - lib/susanoo/assets.rb
@@ -257,9 +259,7 @@ files:
 - lib/susanoo/static_generator.rb
 - lib/susanoo/tasks.rb
 - lib/susanoo/tasks/assets.rake
-- lib/susanoo/tasks/compile.rake
 - lib/susanoo/tasks/debug.rake
-- lib/susanoo/tasks/run.rake
 - lib/susanoo/templates/application/.gitignore
 - lib/susanoo/templates/application/Gemfile
 - lib/susanoo/templates/application/Rakefile

data/lib/susanoo/tasks/compile.rake

@@ -1,10 +0,0 @@
-namespace :compile do
-  #require 'susanoo'
-  [:android, :ios, "amazon-fireos", "ubuntu", "wp7", "wp8", "tizen"].each do |platform|
-    desc "compile application for #{platform} platform"
-    task platform do
-      Rake::Task["assets"].invoke
-      system "cordova compile #{platform}"
-    end
-  end
-end

data/lib/susanoo/tasks/run.rake

@@ -1,10 +0,0 @@
-namespace :run do
-  [:android, :ios, 'amazon-fireos', 'ubuntu', 'wp7', 'wp8', 'tizen'].each do |platform|
-    desc "run application for #{platform} platform"
-    task platform do
-      Rake::Task['assets'].invoke
-      Rake::Task['compile'].invoke
-      system "cordova run #{platform}"
-    end
-  end
-end