confirmed, superuser, Administrators
841
edits
Changes
Introduction to Git for Development (view source)
Revision as of 15:59, 19 November 2022
, 15:59, 19 November 2022→Developing with Git: Added more info on project under git
== Introduction to Git CLI ==
== Introduction to Git CLI ==
All Git commands within this section must be run from within the project directory/repository.
=== Setting up Git in a project directory ===
=== Setting up Git in an existing project directory ===
When setting up a Git project make sure you are in the root (top level) directory for your project and run the following command:
When setting up a Git project make sure you are in the root (top level) directory for your project and run the following command:
this initialises the repository and adds a hidden <code>.git</code> directory which will contain the archived project versions.
this initialises the repository and adds a hidden <code>.git</code> directory which will contain the archived project versions.
There is no set requirement for a remote server, Git can be used completely offline if you prefer to not upload files.
=== Setting a Remote Address ===
=== Setting a Remote Address ===
In order to be able to upload your project onto GitHub (or any other Git hosting site) you need to create a repository (see below) and then copy the clone URL. There are two options, either cloning using HTTPS which will require you set up a temporary access key, or SSH which requires setting up a more permanent SSH key.
In order to be able to upload your project onto GitHub you need to firstly [https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository create a remote repository] and then copy the clone URL. There are two options, either cloning using HTTPS which will require you set up a temporary access key, or SSH which requires setting up a more permanent SSH key, these are outlined here:
* [https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent SSH key generation].
To add the URL as the remote repository for your local project run:
To add the URL as the remote repository for your local project run:
== Creating a RailOS Project with Git ==
== Creating a RailOS Project with Git ==
There is a drive towards standardising the directory structure with RailOS projects such that metadata can be parsed and files located with ease. As such it is recommend that projects be created using the template repository located under the RailOS GitHub organisation which can be found [https://github.com/Railway-Op-Sim/UN-Template here]. By clicking "Use this Template" you can create a new repository, if you plan on opening up to contributions from the community you can create the repository under the organisation itself. To do this you will firstly need to request to be added to the organisation.