falkorlib 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7404b7fd3411800081fd155935da665979a7a493
-  data.tar.gz: 7787857ad80882180f9558299b2ff012c48ac202
+  metadata.gz: 8c3236e419d1298b136ca095a3281e55bbd95c24
+  data.tar.gz: 738b0c020f67cb4fe942c0d8f0b20152e08093d6
 SHA512:
-  metadata.gz: 983ed35dfc02c2dfc7edce8e7b55e732753a77362aec3fe0da1ba4be47138d94c16b4296410af8a4c0254a4b8b9f602dd90eed5bc38e318643ff02b61d976077
-  data.tar.gz: 22619f68a31bc6c3ec9fdb49152b0b464e5d2590917284a8edb731c534a855d126c3f300ad1187d0319e2906b7b64375fb4320284c4bbfc572681c0dd30d1ac2
+  metadata.gz: 2ee4c52e5143aa60d36db2485f648232c7fce15103143f8b24fd375257ad177457677df4a8aea5497f6d9fab325cd98afe0ad24812ca46ee510f6205b6f7127c
+  data.tar.gz: 425cb5392539fef2b19386b2c59436495731719d879f1643e9cc1c940e12dc987597a2a75d2f70957613d2ea7051830bef2fb4ecfd36f6cbe803b418368c0f8c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.7.0)
+    falkorlib (0.7.2)
       activesupport (~> 4.0)
       artii (>= 2.1)
       awesome_print (~> 1.2)

data/completion/_falkor

@@ -1,7 +1,7 @@
 #compdef falkor
 ########################################################################################
 # -*- mode:sh; -*-
-# Time-stamp: <Mon 2016-11-14 15:24 svarrette>
+# Time-stamp: <Sun 2017-01-15 23:15 svarrette>
 #
 # ZSH completion for [FalkorLib](https://github.com/Falkor/falkorlib)
 #
@@ -43,6 +43,7 @@ _falkor()
         'init:Bootstrap a Git Repository the falkor way'
         'link:Initialize a special symlink (.root, .makefile.d etc.)'
         'motd:bootstrap a Message of the Day (motd) file'
+        'mkdocs:Initialize mkdocs for the current project'
         'new:Initialize the directory PATH with one of Falkors template(s)'
         'version:Prints the FalkorLib version information'
     )
@@ -71,11 +72,13 @@ _falkor()
                 (config)
                     __falkor_config && ret=0 ;;
                 (init)
-                    __falkor_init && ret=0   ;;
+                    __falkor_init   && ret=0   ;;
                 (link)
                     __falkor_link   && ret=0 ;;
+                (mkdocs)
+                    __falkor_mkdocs && ret=0   ;;
                 (motd)
-                    __falkor_motd && ret=0   ;;
+                    __falkor_motd   && ret=0   ;;
                 (new)
                     __falkor_new    && ret=0 ;;
                 (version|*)
@@ -228,6 +231,17 @@ __falkor_init() {
 }
 
 
+##################
+__falkor_mkdocs() {
+    local curcontext=$curcontext state line ret=1
+    declare -A opt_args
+
+    _arguments -C \
+               {--force,-f}'[Force generation]'
+               '*:directory:_files -/'
+}
+
+
 ##################
 __falkor_motd() {
     local curcontext=$curcontext state line ret=1

data/lib/falkorlib/bootstrap/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sat 2016-11-12 09:21 svarrette>
+# Time-stamp: <Sun 2017-01-15 22:52 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -177,7 +177,7 @@ module FalkorLib
         puts "  ... not overwriting the #{file} file which already exists"
       else
         FalkorLib::Versioning.set_version(version, path, :type => 'file',
-                                                         :source => { :filename => file })
+                                          :source => { :filename => file })
         Dir.chdir( path ) do
           run %( git tag #{options[:tag]} ) if options[:tag]
         end
@@ -298,7 +298,7 @@ module FalkorLib
         #next unless [ :name, :summary, :description ].include?(k.to_sym)
         default_answer = case k
                          when :author
-                           (config[:by] == 'ULHPC') ? 'UL HPC Management Team' : config[:author]
+                           (config[:by] == 'ULHPC') ? 'UL HPC Team' : config[:author]
                          when :mail
                            (config[:by] == 'ULHPC') ? 'hpc-sysadmins@uni.lu'   : config[:mail]
                          when :description
@@ -383,6 +383,54 @@ module FalkorLib
       #licence
     end # select_licence
 
+    ###### guess_project_config ######
+    # Guess the project configuration
+    ##
+    def guess_project_config(dir = Dir.pwd, options = {})
+      path = normalized_path(dir)
+      use_git = FalkorLib::Git.init?(path)
+      rootdir = (use_git) ? FalkorLib::Git.rootdir(path) : path
+      local_config = FalkorLib::Config.get(rootdir, :local)
+      return local_config[:project] if local_config[:project]
+      # Otherwise, guess the rest of the configuration
+      config = FalkorLib::Config::Bootstrap::DEFAULTS[:metadata].clone
+      # Apply options (if provided)
+      [ :name, :forge ].each do |k|
+        config[k.to_sym] = options[k.to_sym] if options[k.to_sym]
+      end
+      config[:name] = ask("\tProject name: ", get_project_name(dir)) if config[:name].empty?
+      if (use_git)
+        config[:origin] = FalkorLib::Git.config('remote.origin.url')
+        if config[:origin] =~ /((gforge|gitlab|github)[\.\w_-]+)[:\d\/]+(\w*)/
+          config[:forge] = Regexp.last_match(2).to_sym
+          config[:by]    = Regexp.last_match(3)
+        elsif config[:forge].empty?
+          config[:forge] = select_forge(config[:forge]).to_sym
+        end
+      end
+      forges = FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ]
+      default_source = case config[:forge]
+                       when :gforge
+                         'https://' + forges[:url] + "/projects/" + config[:name].downcase
+                       when :github, :gitlab
+                         'https://' + forges[:url] + "/" + config[:by] + "/" + config[:name].downcase
+                       else
+                         ""
+                       end
+      config[:source] = config[:project_page] = default_source
+      config[:issues_url] =  "#{config[:project_page]}/issues"
+      config[:license] = select_licence if config[:license].empty?
+      [ :summary  ].each do |k|
+        config[k.to_sym] = ask( "\t" + Kernel.format("Project %-20s", k.to_s))
+      end
+      config[:description] = config[:summary]
+      config[:gitflow] = FalkorLib::GitFlow.guess_gitflow_config(rootdir)
+      config[:make] = File.exists?(File.join(rootdir, 'Makefile'))
+      config[:rake] = File.exists?(File.join(rootdir, 'Rakefile'))
+      config
+    end # guess_project_config
+
+
     ###### get_badge ######
     # Return a Markdown-formatted string for a badge to display, typically in a README.
     # Based on http://shields.io/

data/lib/falkorlib/bootstrap/latex.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sat 2016-11-12 12:18 svarrette>
+# Time-stamp: <Sun 2017-01-15 22:57 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #

data/lib/falkorlib/bootstrap/mkdocs.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Sun 2017-01-15 23:22 svarrette>
+################################################################################
+# Interface for the main Bootstrapping operations
+#
+
+require "falkorlib"
+require "falkorlib/common"
+require "falkorlib/bootstrap"
+
+require 'erb' # required for module generation
+require 'artii'
+require 'facter'
+
+include FalkorLib::Common
+
+module FalkorLib
+  module Bootstrap #:nodoc:
+
+    module_function
+
+    ###### mkdocs ######
+    # Initialize MkDocs in the current directory
+    # Supported options:
+    #  * :force       [boolean] force overwritting
+    ##
+    def mkdocs(dir = Dir.pwd, options = {})
+      info "Initialize MkDocs (see http://www.mkdocs.org/)"
+      path = normalized_path(dir)
+      use_git = FalkorLib::Git.init?(path)
+      rootdir = (use_git) ? FalkorLib::Git.rootdir(path) : path
+      templatedir = File.join( FalkorLib.templates, 'mkdocs')
+      config = guess_project_config(rootdir, options)
+      config[:sitename] = ask("\tSite name: ", config[:name].capitalize)
+      puts config.to_yaml
+      #FalkorLib::GitFlow.start('feature', 'mkdocs', rootdir) if (use_git && FalkorLib::GitFlow.init?(rootdir))
+      init_from_template(templatedir, rootdir, config,
+                         :no_interaction => true,
+                         :no_commit => true)
+      Dir.chdir( File.join(rootdir, 'docs')) do
+        run %(ln -s README.md index.md )
+        run %(ln -s README.md contributing/index.md )
+        run %(ln -s README.md setup/index.md )
+      end
+      #exit_status.to_i
+    end # mkdocs
+
+  end # module Bootstrap
+end # module FalkorLib

data/lib/falkorlib/bootstrap.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Tue 2016-11-01 10:05 svarrette>
+# Time-stamp: <Sun 2017-01-15 16:25 svarrette>
 ################################################################################
 # Management of Bootstrapping operations
 
@@ -15,5 +15,6 @@ require "falkorlib/bootstrap/link"
 require "falkorlib/bootstrap/ruby"
 require "falkorlib/bootstrap/git"
 require "falkorlib/bootstrap/latex"
+require "falkorlib/bootstrap/mkdocs"
 
 #require "falkorlib/bootstrap/repo"

data/lib/falkorlib/cli.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2016-11-07 22:42 svarrette>
+# Time-stamp: <Sun 2017-01-15 23:13 svarrette>
 ################################################################################
 # Interface for the CLI
 #
@@ -110,6 +110,16 @@ By default, <PATH> is '.' meaning that the repository will be initialized in the
       desc "link <TYPE> [<path>]", "Initialize a special symlink in <path> (the current directory by default)"
       subcommand "link", FalkorLib::CLI::Link
 
+      ###### mkdocs ######
+      method_option :force, :aliases => '-f', :default => false, :type => :boolean,
+                    :desc => "Force generation (might overwrite files)"
+      #......................................
+      desc "mkdocs [options]", "Initialize mkdocs for the current project"
+      def mkdocs(path = '.')
+        FalkorLib::Bootstrap.mkdocs(path, options)
+      end # mkdocs
+
+
 
       ###### motd ######
       method_option :file,     :aliases => '-f', :default => '/etc/motd',

data/lib/falkorlib/git/flow.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Fri 2016-11-11 16:15 svarrette>
+# Time-stamp: <Sun 2017-01-15 22:54 svarrette>
 ################################################################################
 # Management of Git Flow operations
 
@@ -185,6 +185,26 @@ module FalkorLib
       #confs[type.to_sym]
     end # master_branch
 
+    ###### guess_gitflow_config ######
+    # Guess the gitflow configuration
+    ##
+    def guess_gitflow_config(dir = Dir.pwd, options = {})
+      path = normalized_path(dir)
+      use_git = FalkorLib::Git.init?(path)
+      return {} if (!use_git or !FalkorLib::GitFlow.init?(path))
+      rootdir = FalkorLib::Git.rootdir(path)
+      local_config = FalkorLib::Config.get(rootdir, :local)
+      return local_config[:gitflow] if local_config[:gitflow]
+      config = FalkorLib::Config::GitFlow::DEFAULTS.clone
+      [ :master, :develop ].each do |br|
+        config[:branches][br.to_sym] = FalkorLib::Git.config("gitflow.branch.#{br}", rootdir)
+      end
+      [ :feature, :release, :hotfix, :support, :versiontag ].each do |p|
+        config[:prefix][p.to_sym] = FalkorLib::Git.config("gitflow.prefix.#{p}", rootdir)
+      end
+      config
+    end # guess_gitflow_config
+
 
   end # module FalkorLib::GitFlow
 

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, 7, 0
+    MAJOR, MINOR, PATCH = 0, 7, 2
 
     module_function
 

data/templates/mkdocs/docs/README.md.erb

@@ -0,0 +1,24 @@
+-*- mode: markdown; mode: visual-line; fill-column: 80 -*-
+
+<% 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 %>
+![By <%= config[:by] %>](https://img.shields.io/badge/by-<%= config[:by] %>-blue.svg) [![<%= config[:forge] %>](https://img.shields.io/badge/git-<%= config[:forge] %>-lightgray.svg)](<%= config[:source] %>) [![Issues](https://img.shields.io/badge/issues-<%= config[:forge] %>-green.svg)](<%= config[:issues_url] %>)
+
+       Time-stamp: <Sun 2017-01-15 16:58 svarrette>
+
+       <%= ::Artii::Base.new().asciify( config[:name] ).split("\n").join("\n       ") %>
+       Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
+
+<%= config[:description] %>
+
+
+This is the main page of the documentation for this repository, which relies on [MkDocs](http://www.mkdocs.org/) and the [Read the Docs](http://readthedocs.io) theme. It proposes to detail the following elements:
+
+* The [organization and directory layout](layout.md)
+* Complete [Installation](setup/index.md) notes, including:
+    - [Pre-requisites / Preliminary software](setup/preliminaries.md) to install
+* How to [contribute](contributing/index.md) to the development of this project. In particular, we detail:
+     - the steps to follow to [setup this repository](contributing/setup.md)
+     - information as regard the [semantic versioning](contributing/versioning.md) of this project
+     - Apart form the directory layout, we will cover various configuration aspects (mainly the [git-flow](https://github.com/nvie/gitflow) workflow)

data/templates/mkdocs/docs/contributing/README.md.erb

@@ -0,0 +1,18 @@
+<% unless (config[:license].empty? or config[:license] == "none") %>
+This project is released under the terms of the [<%= config[:license] %>](LICENSE) licence.
+
+[![Licence](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:logo]  %>)](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:url] %>)
+<% end %>
+You are more than welcome to contribute to the development of this project as follows (assuming you belong to the project on <%= config[:forge].capitalize %>):
+
+1. Create your own feature branch, eventually prefixed with your login on <%= config[:forge].capitalize %>:
+
+        $> git checkout -b mylogin/my-new-feature   # ADAPT mylogin accordingly
+
+2. Commit your changes (`git commit -am 'Added some feature'`)
+3. Push to the branch (`git push origin mylogin/my-new-feature`)
+4. Create a new [Merge Request](https://gitlab.uni.lu/help/user/project/merge_requests.md) to submit your changes to me.
+
+This assumes that you have understood the [directory tree structure](../layout.md) of this repository.
+
+Finally, you shall be aware of the way the [semantic versioning](versioning.md) procedure of this project is handled.

data/templates/mkdocs/docs/contributing/setup.md.erb

@@ -0,0 +1,26 @@
+There is a number of pre-requisite programs / framework you shall install to be able to correctly contribute to this project.
+
+<% if config[:gitflow] %>
+__Git Branching Model__
+
+The Git branching model for this repository follows the guidelines of
+[gitflow](http://nvie.com/posts/a-successful-git-branching-model/) (see also [this description](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)).
+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.
+
+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.
+<% end %>
+
+__Repository Setup__
+
+As mentioned in the [installation notes](../setup/install.md), to make your local copy of the repository ready to use the [git-flow](https://github.com/nvie/gitflow) workflow
+
+<% if config[:make] %>
+    $> make setup
+<% else %>
+    $> rake setup
+<% end %>
+
+This will also initiate the [Git submodules of this repository](.gitmodules) for this repository.

data/templates/mkdocs/docs/contributing/versioning.md.erb

@@ -0,0 +1,30 @@
+The operation consisting of releasing a new version of this repository is automated by a set of tasks within the root `<%= options[: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:
+
+     $> <%= options[:make] ? 'make versioninfo' : 'rake version:info' %>
+
+If a new version number such be bumped, you simply have to run:
+
+      $> <%= options[:make] ? 'make start_bump_{major,minor,patch}' : 'rake version:bump:{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:
+
+      $> <%= options[: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/mkdocs/docs/layout.md.erb

@@ -0,0 +1,17 @@
+
+This repository is organized as follows:
+
+~~~bash
+.
+├── LICENSE.txt     # Licence of this project
+<% unless options[:rake] %>
+├── Rakefile        # Ruby Rake configuration
+<% else %>
+├── Makefile        # GNU Make configuration
+<% end %>
+├── README.md       # Project README
+├── VERSION         # /!\ DO NOT EDIT. Current repository version
+├── docs/           # [MkDocs](mkdocs.org) main directory
+├── mkdocs.yml      # [MkDocs](mkdocs.org) configuration
+└── src/            # Source Code
+~~~

data/templates/mkdocs/docs/setup/README.md.erb

@@ -0,0 +1,6 @@
+
+This directory holds the documentation to properly setup the <%= config[:name] %> project on your machine.
+In particular, check the following resources:
+
+* [Pre-requisites / Preliminary software](preliminaries.md) to install
+* How to [Clone and Setup](install.md) your local copy of this repository

data/templates/mkdocs/docs/setup/install.md.erb

@@ -0,0 +1,50 @@
+
+This repository is hosted on [<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:name] %>](<%= config[:project_page] %>).
+
+<% if (config[:forge] == :gitlab) %>
+* Git interactions with this repository (push, pull etc.) are performed over SSH using the port 8022
+<% end %>
+* To clone this repository, proceed as follows (adapt accordingly):
+
+        $> mkdir -p ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
+        $> cd ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
+        $> git clone <%= config[:origin] %>
+
+<% if config[:type].include?( :rvm ) %>
+Now ensure [RVM](https://rvm.io/) is correctly configured for this repository:
+
+     $> rvm current
+
+Configure the dependencies detailed in the [`Gemfile`](Gemfile) through the [Bundler](http://bundler.io/):
+
+     $> gem install bundler
+     $> bundle install
+     $> rake -T     # should work ;)
+<% end %>
+
+**`/!\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running:
+
+    $> cd <%= name.downcase %>
+<% if options[:make] %>
+    $> make setup
+<% else %>
+    $> rake setup
+<% end %>
+
+This will initiate the [Git submodules of this repository](.gitmodules) and setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository.
+
+Later on, you can upgrade the [Git submodules](.gitmodules) to the latest version by running:
+
+<% if options[:make] %>
+    $> make upgrade
+<% else %>
+    $> rake git:submodules:upgrade
+<% end %>
+
+If upon pulling the repository, you end in a state where another collaborator have upgraded the Git submodules for this repository, you'll end in a dirty state (as reported by modifications within the `.submodules/` directory). In that case, just after the pull, you **have to run** the following to ensure consistency with regards the Git submodules:
+
+<% if options[:make] %>
+    $> make update
+<% else %>
+    $> rake git:submodules:update
+<% end %>

data/templates/mkdocs/docs/setup/preliminaries.md.erb

@@ -0,0 +1,71 @@
+
+This projects relies on several components you need to have installed on your system.
+
+* [Git](https://git-scm.com/)
+
+The below instructions will help you to install these components, depending on your running platform.
+
+_Note_: in the following instructions, terminal commands are prefixed by a virtual prompt `$>`which obviously **does not** belong to the command.
+
+## Pre-requisites
+
+* Install the following software, depending on your running platform:
+
+| Platform | Software                                              | Description                           | Usage                   |
+|----------|-------------------------------------------------------|---------------------------------------|-------------------------|
+| Mac OS   | [Homebrew](http://brew.sh/)                           | The missing package manager for macOS | `brew install ...`      |
+| Mac OS   | [Brew Cask Plugin](https://caskroom.github.io)        | Mac OS Apps install made easy         | `brew cask install ...` |
+| Mac OS   | [iTerm2](https://www.iterm2.com/)                     | _(optional)_ enhanced Terminal        |                         |
+| Windows  | [Git for Windows](https://git-for-windows.github.io/) | I'm sure you guessed                  |                         |
+| Windows  | [SourceTree](https://www.sourcetreeapp.com/)          | _(optional)_ enhanced git GUI         |                         |
+| Windows  | [Virtual Box](https://www.virtualbox.org/)            | Free hypervisor provider for Vagrant  |                         |
+| Windows  | [Vagrant](https://www.vagrantup.com/downloads.html)   | Reproducible environments made easy.  |                         |
+
+
+* Follow the below custom instructions depending on your running platform
+
+### Mac OS X
+
+Now that you have [Homebrew](http://brew.sh/) installed:
+
+~~~bash
+$> brew install git-core git-flow    # (newer) Git stuff
+~~~
+
+### Linux (Debian / Ubuntu)
+
+~~~bash
+$> sudo apt-get update
+$> sudo apt-get install git build-essential
+~~~
+
+Adapt the package names (and package manager) in case you are using another Linux distribution.
+
+
+### Windows
+
+Follow the instructions provided on this [tutorial](http://rr-tutorials.readthedocs.io/en/latest/setup/#windows).
+In particular, it may be a good idea to rely on [Vagrant](https://www.vagrantup.com/) to run a Linux box.
+
+
+## Post-Installations checks
+
+(Eventually) Make yourself known to Git
+
+~~~bash
+$> git config –-global user.name  "Firstname LastName"              # Adapt accordingly
+$> git config –-global user.email "Firstname.LastName@domain.org"   # Adapt with your mail
+~~~
+
+Clone the [project repository](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:name] %><%=config[:project_page] %> from a Terminal (Powershell as `administrator` under windows):
+
+~~~bash
+$> mkdir -p ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
+$> cd ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
+$> git clone <%= config[:origin] %>
+<% if options[:make] %>
+$> make setup    # Under Mac OS / Linux
+<% else %>
+$> rake setup    # Under Mac OS / Linux
+<% end %>
+~~~

data/templates/mkdocs/mkdocs.yml.erb

@@ -0,0 +1,13 @@
+site_name: <%= config[:sitename] %>
+pages:
+- Home: 'index.md'
+- Organization: 'layout.md'
+- Getting Started:
+  - Pre-Requisites: 'setup/preliminaries.md'
+  - Installation: 'setup/install.md'
+- Contributing:
+  - Overview: 'contributing/index.md'
+  - Directory Layout: 'layout.md'
+  - Repository Setup and Developments: 'contributing/setup.md'
+  - Semantic Versioning: 'contributing/versioning.md'
+theme: readthedocs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -420,6 +420,7 @@ files:
 - lib/falkorlib/bootstrap/git.rb
 - lib/falkorlib/bootstrap/latex.rb
 - lib/falkorlib/bootstrap/link.rb
+- lib/falkorlib/bootstrap/mkdocs.rb
 - lib/falkorlib/bootstrap/ruby.rb
 - lib/falkorlib/cli.rb
 - lib/falkorlib/cli/config.rb
@@ -506,6 +507,15 @@ files:
 - templates/latex/images/question.jpg
 - templates/latex/letter/_content.md.erb
 - templates/latex/letter/main.tex.erb
+- templates/mkdocs/docs/README.md.erb
+- templates/mkdocs/docs/contributing/README.md.erb
+- templates/mkdocs/docs/contributing/setup.md.erb
+- templates/mkdocs/docs/contributing/versioning.md.erb
+- templates/mkdocs/docs/layout.md.erb
+- templates/mkdocs/docs/setup/README.md.erb
+- templates/mkdocs/docs/setup/install.md.erb
+- templates/mkdocs/docs/setup/preliminaries.md.erb
+- templates/mkdocs/mkdocs.yml.erb
 - templates/motd/motd.erb
 - templates/puppet/modules/.gitignore
 - templates/puppet/modules/.pmtignore