Checkout Code

From Gephi:Wiki
Jump to: navigation, search

Gephi source code is hosted on Github platform, and use Git for source control. Getting Gephi’s sources in a "read-only" mode is straightforward and don’t require any registration. However, for contributors and plug-ins developers you'll need to sign-in on Github and set up your account. Hopefully, this is easy and well documented. This tutorial covers how to get the code and set up the proper environment.

Windows

Step 1: Install Git

  1. Go on Git website and get the latest Windows Full installer.
  2. Run Git setup and follow the steps. Checkout Github's help page for more help.

Step 2: Sign-in on Github and set up your SSH Key

If you already have an account on Github, skip this step.

  1. Sign-up on Github
  2. Set up you SSH key for your account.

Step 3: Fork the repository on Github

  1. Sign-in on Github an visit Gephi's repository
  2. Click on "Fork" on the top right. This is basically creating a copy of Gephi's code just for you.

Now you're ready to get the code!

Step 4 : Checkout the code

  1. Open the Git Bash, available from the start menu (Git > Git Bash).
  2. Type the command git clone git@github.com:username/gephi.git' where username is your Github login (not email). If asked for a RSA fingerprint, answer yes.

Get more help on Github's help

If you get a Permission denied (publickey), something is wrong with your [SSH key SSH key].

and see next step.

Mac OS X

Step 1: Install Git

  1. Go on Git website and get the latest Mac OS X installer.
  2. Run Git setup and follow the steps. You can then open a terminal (Application > Utilities > Terminal) and test the gitcommand.

A good user interface for Git is GitX. Once installed just type 'gitx in your repository.

Step 2: Sign-in on Github and set up your SSH Key

If you already have an account on Github, skip this step.

  1. Sign-up on Github
  2. Set up you SSH key for your account.

Step 3: Fork the repository on Github

  1. Sign-in on Github an visit Gephi's repository
  2. Click on "Fork" on the top right. This is basically creating a copy of Gephi's code just for you.

Now you're ready to get the code!

Step 4 : Checkout the code

  1. Open the Git Bash, available from the start menu (Git > Git Bash).
  2. Type the command git clone git@github.com:username/gephi.git' where username is your Github login (not email). If asked for a RSA fingerprint, answer yes.

Get more help on Github's help

If you get a Permission denied (publickey), something is wrong with your [SSH key SSH key].

and see next step.

Linux

Step 1: Install Git

  1. Install Git on your distribution. Checkout Github's help page for more help.

Step 2: Sign-in on Github and set up your SSH Key

If you already have an account on Github, skip this step.

  1. Sign-up on Github
  2. Set up you SSH key for your account.

Step 3: Fork the repository on Github

  1. Sign-in on Github an visit Gephi's repository
  2. Click on "Fork" on the top right. This is basically creating a copy of Gephi's code just for you.

Now you're ready to get the code!

Step 4 : Checkout the code

  1. Type the command git clone git@github.com:username/gephi.git' where username is your Github login (not email). If asked for a RSA fingerprint, answer yes.

Get more help on Github's help

If you get a Permission denied (publickey), something is wrong with your [SSH key SSH key].

and see next step.