_____   ____   _____     
                                        |  __ \ / __ \ / ____|    
                                        | |  | | |  | | |     ___ 
                                        | |  | | |  | | |    / __|
                                        | |__| | |__| | |____\__ \
                                        |_____/ \____/ \_____|___/
                              
                              
                    Copyright (c) 2020 Abdallah Ibrahim <[email protected]>

Guide for installing and configuring my devices, projects, libraries, and packages

This repository is hosted on Github.

• To clone this repository, proceed as follows (adapt accordingly):

$> mkdir -p ~/git/github.com/
$> cd ~/git/github.com/
$> git clone [email protected]:AbdallahCoptan/DOCs.git

/!\ IMPORTANT: Once cloned, initiate your local copy of the repository by running:

$> cd docs
$> rake setup

This will initiate the Git submodules of this repository and setup the git flow layout for this repository. Later on, you can update your local branches by running:

 $> rake up

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 make up to ensure consistency with regards the Git submodules:

Finally, you can upgrade the Git submodules to the latest version by running:

$> rake git:submodules:upgrade

You can submit bug / issues / feature request using the AbdallahCoptan/docs Project Tracker

This repository make use of Git 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
• Git book
• Github:help
• Git reference

At least, you shall configure the following variables

   $> git config --global user.name "Your Name Comes Here"
   $> git config --global user.email [email protected]
   # 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 as an example -- if you decide to use it, simply copy it in your home directory and adapt the [user] section.

This project is released under the terms of the Apache-2.0 licence.

That's quite simple:

1. Fork 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