Updated 02/2017

Github can be quite daunting and complex. It can even scare you off at first.

The goal of this article is to get your

  • documents,
  • scripts,
  • images,
  • icons,
  • themes
  • or anything else

online as fast as possible with the lowest possible learning curve.

It will only take two scripts to get your files online.

Do I need github?

– It is a backup system for you.
– Moving from pc to pc and syncing the latest work via github.
– You can easily share files with others.
– Some distro’s make installing from github very easy.
Communicate with others via github.
– Github has a system to follow up issues.
– More visibility for your projects.

Intended for …

We assume only one person will update the github. No collaboration with others.
If you want to collaborate with others, you definitely will need to learn your github commands.

Youtube Tutorials

1. Creating your first github repository

Download the github scripts to create your own github the easy way.
You can use the download button and unzip or use the following command line in the terminal.

Once you have the code you follow the steps in this tutorial. Version number can vary in the future.

 

1. make an account on github

No need to help you there.

2. create a new repository

Choose a name for your repository. You can change it later in settings.

3. git clone the empty repository

Go to a terminal and git clone your own personal repository e.g.

Now you have a folder that only seems empty. There is a hidden folder .git in there.

4. copy/paste scripts

Copy/paste the files from the downloaded Github-Tutorial inside your own github folder. You can copy/paste
the README.md too and change the file. You can see what markdown I have used to have titles, bold, images and youtube.

SCRIPTS RECEIVED AN UPDATE IN THE MEANTIME.

5. Run setup-git-vx.sh

Edit this file so it holds your name and your email.

Run this script ONLY ONCE per computer. All parameters will be added and remembered. It will be kept in your home directory as a hidden file .gitconfig.

6. Run git-vx.sh

Run this script everytime you change your files and they will be updated on your github.

Version will vary in the future.

Let us explain the parts

This file is being used on ALL my githubs. It happens sometimes that you upgrade the kernel (around 100MB) and then push your files to github. Needless to say the github will grow too big. These lines check if there are files called linux*. If so the script will stop.

I work on different computers and sometimes I forget to get the latest files from the net first, giving merging errors. These lines get the latest code first.

The intention is present to actually document the changes for other people to read… but in practice I rarely type a comment with my uploads.

These lines will put the last changes on the net again.

This is the only script you will need from now on.

I run it personally via terminal by typing

 

2. Getting a bit technical (update of 02/2017)

You can actually skip this bit. Not needed but if you are interested, I am going over the code in the two scripts.
I have also included links in the scripts so you can learn more on the net.

3. Most used markdown to make a beautiful ‘homepage’ or README.md

  • making titles or heading 1, 2, …
  • making text bold or italic
  • making numbered and unnumbered lists
  • making a quote
  • making links
  • adding images
  • adding youtube

 

4. Syncing your github repository on an other pc

Assuming we are on a different pc, you take the following steps to get your github files locally.

Open a terminal and type e.g.

If you already have the github but want to update or sync, type this in the terminal

If you changed something, you type this in the terminal to push it back on github.

 

 

 

Forking a github

Creating a “fork” is producing a personal copy of someone else’s project.
Forks act as a sort of bridge between the original repository and your personal copy. Now you can change this project and push your changes to github to be used at a later date. You can submit Pull Requests to help make other people’s projects better by offering your changes up to the original project.

Forking is at the core of social coding at GitHub.

Recommendation and credits

Bookmark this link to have a cheatsheet to all possible markdown for github and thank me later.

https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Bookmark this link to have one of the better guides to know all about github and thank me later.

https://www.atlassian.com/git/tutorials

Pin It on Pinterest