falkorlib 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be6b7e9b76a06c18709b775c77d17e487e318cbd
-  data.tar.gz: 7ba5fa7986575faea59f5c26d085c5f953f444d1
+  metadata.gz: 66b087ab11950e193ccd65ee4139b55641d00afe
+  data.tar.gz: 9c0addcd32c2e2f4c4f42cd8ef82173b351fd641
 SHA512:
-  metadata.gz: 91aeab1807f5b5bbdc057bebe6430d686bbd0471985afa9ef89de425ea8e03530912d0b450fc84092d84ec6e2529c7bebc4a404476ec2a5e36b79fa703e7ac28
-  data.tar.gz: 079ed9bf07a7a96afc217af7e4b66b75e3ada0d595197ed4cede9c043750fbe4b7233016942125d3db1ce5f003ea6f2ec23b066516dced0dfa711bc2d0f90f42
+  metadata.gz: 38b0b4b09e4535c68c63ff4df89bf67eb268b7547c637679e50a5e0c8894090113c3a39e3ae3708d1605cac75c8e1d629f16cba408e9b46a51670cea8f537f6a
+  data.tar.gz: ee95891a9412a8ebe66d124a56aa8f59d6ccbcc4553dcfc3f4d36e14abcfa32e46d64b7503ded8fd3287fa5c4e42fdc7dfa2dc2ef2bac82eb905ceeb7b5c75ec

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.4.1)
+    falkorlib (0.4.2)
+      artii (>= 2.1)
       awesome_print (~> 1.2)
       configatron (~> 3.2)
       deep_merge (~> 1.0.1)
@@ -19,6 +20,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.3.6)
+    artii (2.1.1)
     awesome_print (1.6.1)
     backports (3.6.0)
     codeclimate-test-reporter (0.3.0)

data/falkorlib.gemspec

@@ -136,6 +136,7 @@ Gem::Specification.new do |s|
 	s.add_runtime_dependency("diffy", '>= 3.0')
 	s.add_runtime_dependency("logger", '>= 1.2.8')
     s.add_runtime_dependency("thor",      '>= 0.19')
+    s.add_runtime_dependency("artii",     '>= 2.1')
     #s.add_runtime_dependency("mercenary", '>= 0.3.5')
 
     #

data/lib/falkorlib/bootstrap/base.rb

@@ -1,12 +1,14 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Dim 2015-02-01 14:43 svarrette>
+# Time-stamp: <Mar 2015-02-24 21:58 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
 
 require "falkorlib"
 require "falkorlib/common"
+require 'erb'      # required for module generation
+require 'artii'
 
 include FalkorLib::Common
 
@@ -19,24 +21,62 @@ module FalkorLib  #:nodoc:
               {
                :metadata => {
                              :name         => '',
-                             :version      => '0.0.1',
+                             :type         => [],
                              :author       => "#{ENV['GIT_AUTHOR_NAME']}",
                              :mail         => "#{ENV['GIT_AUTHOR_EMAIL']}",
                              :summary      => "rtfm",
                              :description  => '',
+                             :forge        => :gforge,
                              :source       => '',
                              :project_page => '',
+                             :license      => '',
                              :issues_url   => '',
                              :tags         => []
                             },
                :trashdir => '.Trash',
-               :types    => [ 'article', 'slides', 'gem', 'octopress', 'puppet_module', 'rvm' ],
+               :types    => [ :latex, :gem, :octopress, :puppet_module, :rvm, :pyenv ],
+               :licenses => {
+                             "none"       => {},
+                             "Apache-2.0" => {
+                                              :url  => "http://www.apache.org/licenses/LICENSE-2.0",
+                                              :logo => "https://www.apache.org/images/feather-small.gif"
+                                             },
+                             "BSD"        => {
+                                              :url  => "http://www.linfo.org/bsdlicense.html",
+                                              :logo => "http://upload.wikimedia.org/wikipedia/commons/thumb/b/bf/License_icon-bsd.svg/200px-License_icon-bsd.svg.png"
+                                             },
+                             "CC by-nc-sa" => {
+                                               :name => "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International",
+                                               :url  => "http://creativecommons.org/licenses/by-nc-sa/4.0",
+                                               :logo => "https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png"
+                                              },
+                             "GPL-2.0"    => {
+                                              :url  => "http://www.gnu.org/licenses/gpl-2.0.html",
+                                              :logo => "https://licensebuttons.net/l/GPL/2.0/88x62.png"
+                                             },
+                             "GPL-3.0"    => {
+                                              :url  => "http://www.gnu.org/licenses/gpl-3.0.html",
+                                              :logo => "https://www.gnu.org/graphics/gplv3-88x31.png",
+                                             },
+                             "LGPL-2.1"   => {
+                                              :url  => "https://www.gnu.org/licenses/lgpl-2.1.html",
+                                              :logo => "https://licensebuttons.net/l/LGPL/2.1/88x62.png",
+                                             },
+                             "LGPL-3.0"   => {
+                                              :url  => "https://www.gnu.org/licenses/lgpl.html",
+                                              :logo => "https://www.gnu.org/graphics/lgplv3-88x31.png",
+                                             },
+                             "MIT"        => {
+                                              :url  => "http://opensource.org/licenses/MIT",
+                                              :logo => "http://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/License_icon-mit-2.svg/200px-License_icon-mit-2.svg.png"
+                                             },
+                            },
                :puppet   => {},
                :forge => {
-                          :gforge => { :url => 'http://gforge.uni.lu', :name => 'GForge @ Uni.lu' },
-                          :github => { :url => 'http://github.com',    :name => 'Github', :login => 'ULHPC' },
-                          :gitlab => { :url => 'http://gitlab.uni.lu', :name => 'Gitlab @ Uni.lu' },
-                          :none   => { :url => '', :name => "None"}
+                          :none   => { :url => '', :name => "None"},
+                          :gforge => { :url => 'https://gforge.uni.lu', :name => 'GForge @ Uni.lu' },
+                          :github => { :url => 'https://github.com',    :name => 'Github', :login => "#{`whoami`.chomp.capitalize}" },
+                          :gitlab => { :url => 'https://gitlab.uni.lu', :name => 'Gitlab @ Uni.lu' },
                          },
               }
 
@@ -147,6 +187,11 @@ module FalkorLib
         # :make        [boolean] Use a Makefile to pilot the repository actions
         # :rake        [boolean] Use a Rakefile (and FalkorLib) to pilot the repository action
         # :remote_sync [boolean] Operate a git remote synchronization
+        # :latex       [boolean] Initiate a LaTeX project
+        # :gem         [boolean] Initiate a Ruby gem project
+        # :rvm         [boolean] Initiate a RVM-based Ruby project
+        # :pyenv       [boolean] Initiate a pyenv-based Python project
+        # :octopress   [boolean] Initiate an Octopress web site
         ##
         def repo(name, options = {})
             ap options if options[:debug]
@@ -205,6 +250,9 @@ module FalkorLib
             # === VERSION file ===
             FalkorLib::Bootstrap.versionfile(path, :tag => 'v0.0.0')
 
+            # === README ===
+            FalkorLib::Bootstrap.readme(path, options)
+
             #===== remote synchro ========
             if options[:remote_sync]
                 remotes  = FalkorLib::Git.remotes(path)
@@ -271,24 +319,99 @@ module FalkorLib
         #  * :latex     [boolean] describe a LaTeX project
         #  * :octopress [boolean] octopress site
         ##
-        def readme(dir = Dir.pwd, type = 'latex', options = {})
-            info "Bootstrap a README file"
-            #if File.exists?(File.join(dir, ))
+        def readme(dir = Dir.pwd, options = {})
+            info "Bootstrap a README file for this project"
+            # get the local configuration
+            local_config = FalkorLib::Config.get(dir)
             config = FalkorLib::Config::Bootstrap::DEFAULTS[:metadata].clone
-            config[:filename] = options[:filename] ? options[:filename] : 'README.md'
-            config[:name]     = options[:name] ? options[:name] : File.basename(dir)
-            default_forge     = options[:forge] ? options[:forge] : :github
-            forges = FalkorLib::Config::Bootstrap::DEFAULTS[:forge]
-            case select_forge(default_forge)
-            when :gforge
-                config[:project_page] = forges[:url] + "/projects/"
+            if local_config[:project]
+                config.deep_merge!( local_config[:project])
+            else
+                config[:name]     = ask("\tProject name: ", get_project_name(dir)) unless options[:name]
             end
+            # Type of project
+            config[:type] << :latex if options[:latex]
+            if config[:type].empty?
+                t = select_from( FalkorLib::Config::Bootstrap::DEFAULTS[:types],
+                                'Select the type of project to describe:')
+                config[:type] << t
+                config[:type] << [ :ruby, :rvm ] if [ :gem, :rvm, :octopress, :puppet_module ].include?( t )
+                config[:type] << :python if t == :pyenv
+            end
+            config[:type] = config[:type].uniq.flatten
+            # Apply options (if provided)
+            [ :name, :forge ].each do |k|
+                config[k.to_sym] = options[k.to_sym] if options[k.to_sym]
+            end
+            path = normalized_path(dir)
+            config[:filename] = options[:filename] ? options[:filename] : File.join(path, 'README.md')
+            config[:forge] = select_forge(config[:forge]).to_sym if config[:forge].empty?
+            forges = FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ]
+            default_source = case config[:forge]
+                             when :gforge
+                                 forges[:url] + "/projects/" + config[:name].downcase
+                             when :github
+                                 forges[:url] + "/" + forges[:login] + "/" + config[:name].downcase
+                             when :gitlab
+                                 forges[:url] + "/" + forges[:name].downcase
+                             end
 
+            FalkorLib::Config::Bootstrap::DEFAULTS[:metadata].each do |k,v|
+                next if v.kind_of?(Array) or [ :license, :forge ].include?( k )
+                next if k == :name and ! name.empty?
+                next if k == :issues_url and ! [ :github, :gitlab ].include?( config[:forge] )
+                #next unless [ :name, :summary, :description ].include?(k.to_sym)
+                default_answer = case k
+                                 when :description
+                                     config[:description].empty? ? "#{config[:summary]}" : "#{config[:description]}" 
+                                 when :source
+                                     config[:source].empty? ? default_source : "#{config[:source]}"
+                                 when :project_page
+                                     config[:source].empty? ? v : config[:source]
+                                 when :issues_url
+                                     config[:project_page].empty? ? v : "#{config[:project_page]}/issues"
+                                 else
+                                     config[k.to_sym].empty? ? v : config[k.to_sym]
+                                 end
+                 config[k.to_sym] = ask( "\t" + sprintf("Project %-20s", "#{k}"), default_answer)
+            end
+            tags = ask("\tKeywords (comma-separated list of tags)", config[:tags].join(','))
+            config[:tags]    = tags.split(',')
+            config[:license] = select_licence() if config[:license].empty?
+            # stack the ERB files required to generate the README
+            templatedir = File.join( FalkorLib.templates, 'README')
+            erbfiles = [ 'header_readme.erb',  ]
+            [ :latex ].each do |type|
+                erbfiles << "readme_#{type}.erb" if options[type.to_sym] and File.exist?( File.join(templatedir, "readme_#{type}.erb"))
+            end
+            erbfiles << "readme_git.erb"     if FalkorLib::Git.init?(dir)
+            erbfiles << "readme_gitflow.erb" if FalkorLib::GitFlow.init?(dir)
+            erbfiles << "readme_rvm.erb"     if config[:type].include?(:rvm)
+            erbfiles << "footer_readme.erb"
 
-            # config[:project_page] = case forge
-            #                         when :gforge
-                                        
-            #                         end
+            content = ""
+            erbfiles.each do |f|
+                erbfile = File.join(templatedir, f)
+                content += ERB.new(File.read("#{erbfile}"), nil, '<>').result(binding)
+            end
+            show_diff_and_write(content, config[:filename], options)
+
+            # Eventually save/upgrade local config
+            info "=> saving customization of the FalkorLib configuration in #{FalkorLib.config[:config_files][:local]}"
+            really_continue?
+            FalkorLib::Config::Bootstrap::DEFAULTS[:metadata].keys.each do |k|
+                local_config[:project] = {} unless local_config[:project]
+                local_config[:project][k.to_sym] = config[k.to_sym]
+            end
+            if FalkorLib::GitFlow.init?(dir)
+                local_config[:gitflow]  = {} unless local_config[:gitflow]
+                local_config[:gitflow][:branches] = FalkorLib.config[:gitflow][:branches].clone unless local_config[:gitflow][:branches]
+                [ :master, :develop ].each do |b|
+                    local_config[:gitflow][:branches][b.to_sym] = FalkorLib::GitFlow.branches(b.to_sym)
+                end
+            end
+            FalkorLib::Config.save(dir, local_config, :local)
+            #
         end # readme
 
         ###
@@ -296,17 +419,51 @@ module FalkorLib
         ##
         def select_forge(default = :gforge, options = {})
             forge = FalkorLib::Config::Bootstrap::DEFAULTS[:forge]
-            ap forge
+            #ap forge
             default_idx = forge.keys.index(default)
-            default_idx = 0 if default_idx.nil? 
+            default_idx = 0 if default_idx.nil?
             v = select_from(forge.map{ |k,v| v[:name] },
                             "Select the Forge hosting the project sources",
                             default_idx+1,
                             forge.keys)
-            ap v
+            v
         end # select_forge
 
+        ###### select_licence ######
+        # Select a given licence for the project
+        ##
+        def select_licence(default_licence = FalkorLib::Config::Bootstrap::DEFAULTS[:metadata][:license],
+                           options = {})
+            list_license    = FalkorLib::Config::Bootstrap::DEFAULTS[:licenses].keys
+            idx = list_license.index(default_licence) unless default_licence.nil?
+            select_from(list_license,
+                        'Select the license index for this project:',
+                        idx.nil? ? 1 : idx + 1)
+            #licence
+        end # select_licence
+
+        ###### get_badge ######
+        # Return a Markdown-formatted string for a badge to display, typically in a README.
+        # Based on http://shields.io/
+        # Supported options:
+        #  * :style [string] style of the badge, Elligible: ['plastic', 'flat', 'flat-square'] 
+        ##
+        def get_badge(subject, status, color = 'blue', options = {})
+            st = status.gsub(/-/, '--').gsub(/_/, '__')
+            res = "https://img.shields.io/badge/#{subject}-#{st}-#{color}.svg"
+            res += "?style=#{options[:style]}" if options[:style]
+            res
+        end # get_licence_badge
+
+        ###### get_project_name ######
+        # Return a "reasonable" project name from a given [sub] directory i.e. its basename
+        ##
+        def get_project_name(dir = Dir.pwd, options = {})
+            path = normalized_path(dir)
+            path = FalkorLib::Git.rootdir(path) if FalkorLib::Git.init?(path)
+            File.basename(path)
+        end # get_project_name
+
 
-        
     end # module Bootstrap
 end # module FalkorLib

data/lib/falkorlib/cli/config.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Mar 2015-02-24 11:04 svarrette>
+################################################################################
+# Management of the configuration specializations
+#
+
+require 'thor'
+require 'falkorlib'
+
+module FalkorLib
+    module CLI
+        class Config #< ::Thor
+            
+
+
+
+            
+        end # class Config
+    end # module CLI
+end # module FalkorLib

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Ven 2015-01-30 15:20 svarrette>
+# Time-stamp: <Mar 2015-02-24 22:03 svarrette>
 ################################################################################
 
 require 'thor'
@@ -37,6 +37,11 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
         :default => 'production', :banner => 'BRANCH', :desc => "Master Branch name for production releases"
       method_option :develop, :aliases => [ '-b', '--branch', '--devel'],
         :default => 'devel', :banner => 'BRANCH', :desc => "Branch name for development commits"
+      method_option :latex, :aliases => '-l', :type => :boolean, :desc => "Initiate a LaTeX project"
+      method_option :gem,   :type => :boolean, :desc => "Initiate a Ruby gem project"
+      method_option :rvm,   :type => :boolean, :desc => "Initiate a RVM-based Ruby project"
+      method_option :pyenv, :type => :boolean, :desc => "Initiate a pyenv-based Python project"
+      method_option :octopress, :aliases => ['-o', '--www'], :type => :boolean, :desc => "Initiate an Octopress web site"
       #___________________
       def repo(name = '.')
        # _newrepo(name, options)
@@ -90,9 +95,19 @@ These files will be committed in Git to ensure a consistent environment for the
 
 
       ###### readme ######
+      method_option :make, :default => true,
+        :type => :boolean, :desc => 'Use a Makefile to pilot the repository actions'
+      method_option :rake,
+        :type => :boolean, :desc => 'Use a Rakefile (and FalkorLib) to pilot the repository actions'
+      method_option :latex, :aliases => '-l', :type => :boolean, :desc => "Describe a LaTeX project"
+      method_option :gem,   :type => :boolean, :desc => "Describe a Ruby gem project"
+      method_option :rvm,   :type => :boolean, :desc => "Describe a RVM-based Ruby project"
+      method_option :pyenv, :type => :boolean, :desc => "Describe a pyenv-based Python project"
+      method_option :octopress, :aliases => '--www', :type => :boolean, :desc => "Describe an Octopress web site"
       #......................................
-      desc "readme PATH [options]", "Initiate a README file in the PATH directory"
+      desc "readme PATH [options]", "Initiate a README file in the PATH directory ('./' by default)"
       def readme(path = '.')
+          ap options
           FalkorLib::Bootstrap.readme(path, options)
       end # readme
     end # class Init

data/lib/falkorlib/cli.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mar 2015-01-20 23:25 svarrette>
+# Time-stamp: <Mar 2015-02-24 11:04 svarrette>
 ################################################################################
 # Interface for the CLI
 #
@@ -43,7 +43,7 @@ module FalkorLib
       end
 
       ###### config ######
-      desc "config", "Print the current configuration of FalkorLib", :hide => true
+      desc "config", "Print the current configuration of FalkorLib" #, :hide => true
       def config
         info "Thor options:"
         puts options.to_yaml

data/lib/falkorlib/common.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sam 2015-01-31 23:54 svarrette>
+# Time-stamp: <Mar 2015-02-24 22:09 svarrette>
 ################################################################################
 
 require "falkorlib"
@@ -256,12 +256,27 @@ module FalkorLib #:nodoc:
         end
 
         # Store the Hash object as a Yaml file
-        def store_config(filepath, hash)
-            File.open( filepath, 'w') do |f|
-                f.print "# ", File.basename(filepath), "\n"
-                f.puts "# /!\\ DO NOT EDIT THIS FILE: it has been automatically generated"
-                f.puts hash.to_yaml
+        # Supported options:
+        #   :header         [string]: additional info to place in the header of the (stored) file
+        #   :no_interaction [boolean]: do not interact
+        def store_config(filepath, hash, options = {})
+            content  = "# " + File.basename(filepath) + "\n"
+            content += "# /!\\ DO NOT EDIT THIS FILE: it has been automatically generated\n"
+            if options[:header]
+                options[:header].split("\n").each { |line| content += "# #{line}" }
             end
+            content += hash.to_yaml
+            show_diff_and_write(content, filepath, options)
+            # File.open( filepath, 'w') do |f|
+            #     f.print "# ", File.basename(filepath), "\n"
+            #     f.puts "# /!\\ DO NOT EDIT THIS FILE: it has been automatically generated"
+            #     if options[:header]
+            #         options[:header].split("\n").each do |line|
+            #             f.puts "# #{line}"
+            #         end
+            #     end
+            #     f.puts hash.to_yaml
+            # end
         end
 
         #################################

data/lib/falkorlib/config.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Jeu 2015-02-12 11:07 svarrette>
+# Time-stamp: <Mar 2015-02-24 11:58 svarrette>
 ################################################################################
 # FalkorLib Configuration
 #
@@ -89,20 +89,38 @@ module FalkorLib #:nodoc:
             res
         end
 
-        ###### load_project ######
-        # Return the local project configuration
+        ###### get ######
+        # Return the { local | private } FalkorLib configuration
+        # Supported options:
+        #  * :file [string] filename for the local configuration
         ##
-        def load_project(dir = Dir.pwd, options = {})
-            project_file = options[:file] ? options[:file] : FalkorLib.config[:config_files][:local]
+        def get(dir = Dir.pwd, type = :local, options = {})
             path = normalized_path(dir)
             path = FalkorLib::Git.rootdir(path) if FalkorLib::Git.init?(path)
+            raise FalkorLib::Error, "Wrong FalkorLib configuration type" unless FalkorLib.config[:config_files].keys.include?( type.to_sym)
+            local_config_file = options[:file] ? options[:file] : File.join(path, FalkorLib.config[:config_files][type.to_sym])
             res = {}
-            #if File.exists?( )
-        end # load_project
+            res = load_config( local_config_file ) if File.exists?( local_config_file )
+            res
+        end # get
 
+        ###### save ######
+        # save the { local | private } configuration on YAML format
+        # Supported options:
+        #  * :file [string] filename for the saved configuration
+        ##
+        def save(dir = Dir.pwd, config = {}, type = :local, options = {})
+            path = normalized_path(dir)
+            path = FalkorLib::Git.rootdir(path) if FalkorLib::Git.init?(path)
+            raise FalkorLib::Error, "Wrong FalkorLib configuration type"unless  FalkorLib.config[:config_files].keys.include?( type.to_sym)
+            conffile = options[:file] ? options[:file] : File.join(path, FalkorLib.config[:config_files][type.to_sym])
+            confdir  = File.dirname( conffile )
+            unless File.directory?( confdir )
+                really_continue? "about to create the configuration directory #{confdir}"
+                run %{ mkdir -p #{confdir} }
+            end
+            store_config(conffile, config)
+        end # save
 
     end
-
-
-
 end # module FalkorLib

data/lib/falkorlib/version.rb

@@ -19,7 +19,7 @@ module FalkorLib #:nodoc:
         # MAJOR: Defines the major version
         # MINOR: Defines the minor version
         # PATCH: Defines the patch version
-	    MAJOR, MINOR, PATCH = 0, 4, 1  
+	    MAJOR, MINOR, PATCH = 0, 4, 2  
 	    
 	    module_function
 	    

data/spec/falkorlib/common_spec.rb

@@ -188,7 +188,7 @@ describe FalkorLib::Common do
 		it "#store_config - should store the correct hash to YAML" do
 			file_config = {:domain => "foo.com", :nested => { 'a1' => 2 }}
 			f = Tempfile.new('toto')
-			store_config(f.path, file_config)
+			store_config(f.path, file_config, { :no_interaction => true })
 			copy_file_config = YAML::load_file(f.path)
 			copy_file_config.should == file_config
 		end

data/templates/README/footer_readme.erb

@@ -1,67 +1,19 @@
+<% unless (config[:license].empty? or config[:license] == "none") %>
+## Licence
 
-## Resources / Complementary information
+This project is released under the terms of the [<%= config[:license] %>](LICENCE) licence. 
 
-### Git 
+[![Licence](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:logo]  %>)](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:url] %>)
+<% end %>
+<% if config[:forge] == :github %>
 
-You should become familiar (if not yet) with Git. Consider these resources: 
+## Contributing
 
-* [Simple Git Guide](http://rogerdudler.github.io/git-guide/)
-* [Git book](http://book.git-scm.com/index.html)
-* [Github:help](http://help.github.com/mac-set-up-git/)
-* [Git reference](http://gitref.org/)
-
-At least, you shall configure the following variables
-
-    $> git config --global user.name "Your Name Comes Here"
-    $> git config --global user.email you@yourdomain.example.com
-    # configure colors
-    $> git config --global color.diff auto
-    $> git config --global color.status auto
-    $> git config --global color.branch auto
-
-You might want also to configure various aliases to Git command.
-Consider my personal [`.gitconfig`](https://github.com/Falkor/dotfiles/blob/master/git/.gitconfig) as an example -- if you decide to use it, simply copy it in your home directory and adapt the `[user]` section. 
-
-### [git-flow](https://github.com/nvie/gitflow)
-
-The Git branching model for this repository follows the guidelines of
-[gitflow](http://nvie.com/posts/a-successful-git-branching-model/).
-In particular, the central repository holds two main branches with an infinite lifetime:
-
-* `<%= config[:gitflow][:branches][:master] %>`: the *production-ready* branch
-* `<%= config[:gitflow][:branches][:develop] %>`: the main branch where the latest developments interviene. This is the *default* branch you get when you clone the repository.
-
-### Releasing mechanism
-
-The operation consisting of releasing a new version of this repository is automated by a set of tasks within the root `<%= config[:rake] ? 'R' : 'M' %>akefile`.
-
-In this context, a version number have the following format:
-
-      <major>.<minor>.<patch>[-b<build>]
-
-where:
-
-* `< major >` corresponds to the major version number
-* `< minor >` corresponds to the minor version number
-* `< patch >` corresponds to the patching version number
-* (eventually) `< build >` states the build number _i.e._ the total number of commits within the `<%= config[:gitflow][:branches][:develop] %>` branch.
-
-Example: \`1.0.0-b28\`
-
-The current version number is stored in the root file `VERSION`. __/!\ NEVER MAKE ANY MANUAL CHANGES TO THIS FILE__
-
-For more information on the version, run:
-
-     $> <%= config[:make] ? 'make versioninfo' : 'rake version:info' %>
-
-If a new version number such be bumped, you simply have to run:
-
-      $> <%= config[:make] ? 'make start_bump_{major,minor,patch}' : 'rake version:{major,minor,patch}' %>
-
-This will start the release process for you using `git-flow`.
-Once you have finished to commit your last changes, make the release effective by running:
-
-      $> <%= config[:make] ? 'make release' : 'rake version:release' %>
-
-it will finish the release using `git-flow`, create the appropriate tag in the `<%= config[:gitflow][:branches][:master] %>` branch and merge all things the way they should be.
+That's quite simple:
 
+1. [Fork](https://help.github.com/articles/fork-a-repo/) it
+2. Create your own feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new [Pull Request](https://help.github.com/articles/using-pull-requests/)
+<% end %>

data/templates/README/header_readme.erb

@@ -1,17 +1,36 @@
 -*- mode: markdown; mode: visual-line; fill-column: 80 -*-
-`<%= config[:filename] %>`
 
-      Time-stamp: <Lun 2015-01-26 10:39 svarrette>
+<% unless (config[:license].empty? or config[:license] == "none") %>
+[![Licence](<%= FalkorLib::Bootstrap::get_badge("license", config[:license], 'blue') %>)](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:url] %>)
+<% end %>
 
-------------------
+       Time-stamp: <Mar 2015-02-24 21:23 svarrette>
 
-# <%= config[:shortname].capitalize %>
+       <%= ::Artii::Base.new().asciify( config[:name] ).split("\n").join("\n       ") %>
+       Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
 
 <%= config[:summary] %>
 
-    Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
+<% unless (config[:license].empty? or config[:license] == "none") %>
+* [<%= config[:license] %> Licence](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:url] %>)
+<% end %>
+* [Sources](<%= config[:source] %>)
 
 ## Synopsis
 
 <%= config[:description] %>
 
+## Installation 
+
+This repository is hosted on [<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:name] %>](<%= config[:project_page] %>). 
+
+**`/!\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running: 
+
+    $> cd <%= config[:name].downcase %>
+<% if options[:make] %>
+    $> make setup
+<% else %>
+    $> gem install rake    # the very first time
+    $> rake setup
+<% end %>
+

data/templates/README/readme_gem.erb

@@ -0,0 +1,18 @@
+## <%= config[:name] %> Gem Installation
+
+You'll typically want to install <%= config[:name] %> using [Bundler](http://bundler.io/).
+To do this, simply add this line to your application's `Gemfile`:
+
+	gem '<%= config[:name].downcase %>'
+	
+And then execute:
+
+	$> bundle
+
+Or install it yourself as:
+
+	$> gem install <%= config[:name].downcase %>
+
+**Note** you probably wants to do the above within an isolated environment. See
+  below for some explanation on this setup.
+

data/templates/README/readme_git.erb

@@ -0,0 +1,44 @@
+
+## Resources
+
+### Git
+
+This repository make use of [Git](http://git-scm.com/) such that you should have
+it installed on your working machine: 
+
+       $> apt-get install git-core # On Debian-like systems
+	   $> yum install git          # On CentOS-like systems
+       $> brew install git         # On Mac OS, using [Homebrew](http://mxcl.github.com/homebrew/)
+       $> port install git         # On Mac OS, using MacPort
+
+Consider these resources to become more familiar (if not yet) with Git:
+
+* [Simple Git Guide](http://rogerdudler.github.io/git-guide/)
+* [Git book](http://book.git-scm.com/index.html)
+* [Github:help](http://help.github.com/mac-set-up-git/)
+* [Git reference](http://gitref.org/)
+
+At least, you shall configure the following variables
+
+       $> git config --global user.name "Your Name Comes Here"
+       $> git config --global user.email you@yourdomain.example.com
+       # configure colors
+       $> git config --global color.diff auto
+       $> git config --global color.status auto
+       $> git config --global color.branch auto
+
+Note that you can create git command aliases in `~/.gitconfig` as follows: 
+
+       [alias]
+           up = pull origin
+           pu = push origin
+           st = status
+           df = diff
+           ci = commit -s
+           br = branch
+           w  = whatchanged --abbrev-commit
+           ls = ls-files
+           gr = log --graph --oneline --decorate
+           amend = commit --amend
+
+Consider my personal [`.gitconfig`](https://github.com/Falkor/dotfiles/blob/master/git/.gitconfig) as an example -- if you decide to use it, simply copy it in your home directory and adapt the `[user]` section. 

data/templates/README/readme_gitflow.erb

@@ -0,0 +1,46 @@
+
+### [Git-flow](https://github.com/nvie/gitflow)
+
+The Git branching model for this repository follows the guidelines of
+[gitflow](http://nvie.com/posts/a-successful-git-branching-model/).
+In particular, the central repository holds two main branches with an infinite lifetime:
+
+* `<%= FalkorLib::GitFlow.branches(:master) %>`: the *production-ready* branch
+* `<%= FalkorLib::GitFlow.branches(:develop) %>`: the main branch where the latest developments interviene. This is the *default* branch you get when you clone the repository.
+
+Thus you are more than encouraged to install the [git-flow](https://github.com/nvie/gitflow) extensions following the [installation procedures](https://github.com/nvie/gitflow/wiki/Installation) to take full advantage of the proposed operations. The associated [bash completion](https://github.com/bobthecow/git-flow-completion) might interest you also.
+
+### Releasing mechanism
+
+The operation consisting of releasing a new version of this repository is automated by a set of tasks within the root `<%= config[:rake] ? 'R' : 'M' %>akefile`.
+
+In this context, a version number have the following format:
+
+      <major>.<minor>.<patch>[-b<build>]
+
+where:
+
+* `< major >` corresponds to the major version number
+* `< minor >` corresponds to the minor version number
+* `< patch >` corresponds to the patching version number
+* (eventually) `< build >` states the build number _i.e._ the total number of commits within the `<%= FalkorLib::GitFlow.branches(:develop) %>` branch.
+
+Example: \`1.0.0-b28\`
+
+The current version number is stored in the root file `VERSION`. __/!\ NEVER MAKE ANY MANUAL CHANGES TO THIS FILE__
+
+For more information on the version, run:
+
+     $> <%= config[:make] ? 'make versioninfo' : 'rake version:info' %>
+
+If a new version number such be bumped, you simply have to run:
+
+      $> <%= config[:make] ? 'make start_bump_{major,minor,patch}' : 'rake version:{major,minor,patch}' %>
+
+This will start the release process for you using `git-flow`.
+Once you have finished to commit your last changes, make the release effective by running:
+
+      $> <%= config[:make] ? 'make release' : 'rake version:release' %>
+
+it will finish the release using `git-flow`, create the appropriate tag in the `<%=  FalkorLib::GitFlow.branches(:master) %>` branch and merge all things the way they should be.
+

data/templates/README/readme_latex.erb

@@ -0,0 +1,10 @@
+## Compilation of the LaTeX sources
+
+The compilation of this document relies on [GNU Make](http://www.gnu.org/software/make/), and you should have a complete working LaTeX environment (including the `pdflatex` compiler).
+
+To compile this document, simply run:
+
+	$> make
+
+This shall generate the PDF version of the document
+

data/templates/README/readme_rvm.erb

@@ -0,0 +1,22 @@
+### Ruby stuff: RVM, Rakefile and Ruby gems
+
+The various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation. You'll also need [Ruby Gems](https://rubygems.org/) to facilitate the installation of ruby libraries.
+
+       $> apt-get install ruby rubygems  # On Debian-like systems
+
+Install the [rake](https://rubygems.org/gems/rake) gem as follows:
+
+       $> gem install rake
+
+In order to have a consistent environment among the collaborators of this project, [Bundler](http://bundler.io/) is also used. Configuration of [Bundler](http://bundler.io/) is made via the [`Gemfile[.lock]` files](http://bundler.io/v1.3/gemfile.html).
+
+Last but not least, I like to work on [Sandboxed environments](https://hpc.uni.lu/blog/2014/create-a-sandboxed-python-slash-ruby-environment/) and a great tool for that is [RVM](https://rvm.io/).
+[RVM](https://rvm.io/) gives you compartmentalized independent ruby setups. 
+This means that ruby, gems and irb are all separate and self-contained - from the system, and from each other.  Sandboxing with [RVM](https://rvm.io/) is straight-forward via the [notion of gemsets](https://rvm.io/gemsets) and is managed via the `.ruby-{version,gemset}` files. 
+
+If things are fine, you should  be able to access the list of available tasks by running:
+
+       $> rake -T
+
+You probably want to activate the bash-completion for rake tasks.
+I personally use the one provided [here](https://github.com/ai/rake-completion).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -184,6 +184,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +350,7 @@ files:
 - lib/falkorlib/bootstrap.rb
 - lib/falkorlib/bootstrap/base.rb
 - lib/falkorlib/cli.rb
+- lib/falkorlib/cli/config.rb
 - lib/falkorlib/cli/new.rb
 - lib/falkorlib/common.rb
 - lib/falkorlib/config.rb
@@ -375,6 +390,11 @@ files:
 - spec/spec_helper.rb
 - templates/README/footer_readme.erb
 - templates/README/header_readme.erb
+- templates/README/readme_gem.erb
+- templates/README/readme_git.erb
+- templates/README/readme_gitflow.erb
+- templates/README/readme_latex.erb
+- templates/README/readme_rvm.erb
 - templates/puppet/modules/.gitignore
 - templates/puppet/modules/.vagrant_init.rb
 - templates/puppet/modules/Gemfile