Setting up Github for OpenCog

From OpenCog
Jump to: navigation, search

Description

This page describes the creation of a Github account and the two ways in which you can access the OpenCog codebase depending on your usage requirements. Github is the code repository service that Opencog now uses to manage and track changes made to the code base by the open source community.

The main difference is defined by whether or not you will pushing back changes you make to the code to the main repository, or if you just need the code for your own personal use. Both procedures are detailed below.

Prerequisites

You should have git installed in your Ubuntu environment, use the command below to install it.

sudo apt-get install git

Contents

Signing up with Github

In either case described above, you will need to sign up with Github. So go to the address below and create an account for yourself if you don't have one yet.

https://github.com/signup/free

Try to limit the amount of uppercase and other 'strange' characters if you want to avoid issues using Github later on.

Github SignUp.png


Follow the steps on screen to complete the registration process. Once you are able to log in with your own Github account, go to the following address:

https://github.com/opencog

You should see OpenCog project with the repositories below it.

Github OpenCog repository.png


Forking the repository you want

Regardless of your choice in the next section, it's good practice to create your own fork for the repository / repositories you want to work with. In most cases, this will be the opencog respository, so click the second repository in the image above to open it or whichever repository you want to work with. You should see something similar to the image below.

Github OpenCog suppository.png


To create your own fork, click the fork icon which has been highlighted in the top right area of the image above. You will be asked where you want to fork it to as shown below, the default location should be ok.

Github fork opencog.png


After some server side processing, you should be redirected to your own fork of the OpenCog codebase, as shown below.

Github private fork opencog.png


To complete the process, you should rename your own fork so it is clear for other people what you are doing. To do this click the 'Admin' button in the top right area of the image above (just below the 'Fork' button you found previously) to open the Admin page.

Github private fork opencog admin.png


Change the name of your repository to something suitable, maybe opencog-testing or opencog-experimental. The name only has to be unique with your personal folder, so the examples mentioned before should work for you.

Once you click 'Rename' you will be shown an ominous warning, but since we are working in a fresh fork there should be no real danger.

That sets up your own fork of the OpenCog component(s) you want to work on in your own area of Github.

"I just want to download and play with the code"

TBC

"I want to download the code and be able to push my changes back to Github"

TBC

Next Steps

None yet.

Q&A

Any questions?

Not right now, no.