Introduction to Git for Development - Revision history

Krizar: /* Developing with Git */Added more info on project under git

2022-11-19T15:59:21Z

Developing with Git: Added more info on project under git

2022-08-27T06:39:33Z

Setting a Remote Address

2022-08-27T06:39:02Z

Setting up Git in an existing project directory

2022-08-27T06:38:28Z

Setting up Git in an existing project directory

2022-08-27T06:37:41Z

Setting up Git in a project directory

2022-08-27T06:34:38Z

Setting a Remote Address

2022-08-27T05:37:39Z

Introduction to Git CLI

2022-08-27T05:36:47Z

Setting a Remote Address

2022-08-26T22:57:06Z

Setting up Git in a project directory: Minor additions

2022-08-26T19:38:12Z

← Older revision		Revision as of 15:59, 19 November 2022
Line 41:		Line 41:

	== 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.

← Older revision		Revision as of 06:39, 27 August 2022
Line 33:		Line 33:
	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:		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:

−	* [~~SSH key generation](~~https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)	+	* [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].

@@ Line 28: / Line 28: @@
 this initialises the repository and adds a hidden <code>.git</code> directory which will contain the archived project versions.
-There is no requirement for a remote server, Git can be used completely offline.
+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 ===

@@ Line 20: / Line 20: @@
 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:
@@ Line 28: / Line 28: @@
 this initialises the repository and adds a hidden <code>.git</code> directory which will contain the archived project versions.
-There is no requirement for a remote server, Git can be used completely offline. However if you plan on pushing your project to GitHub you can create a repository on your account first then clone this locally using:
+There is no requirement for a remote server, Git can be used completely offline.
 === Setting a Remote Address ===

← Older revision		Revision as of 06:37, 27 August 2022
Line 27:		Line 27:

	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 requirement for a remote server, Git can be used completely offline. However if you plan on pushing your project to GitHub you can create a repository on your account first then clone this locally using:
		+
		+	<code>git clone <repository-clone-url></code>
		+
		+	with this option you won't need to set a remote address later on. Details on creating a remote repository can be found below.

	=== Setting a Remote Address ===		=== Setting a Remote Address ===

@@ Line 29: / Line 29: @@
 === 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:
 To add the URL as the remote repository for your local project run:

← Older revision		Revision as of 05:37, 27 August 2022
Line 18:		Line 18:

	== 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 a project directory ===

← Older revision		Revision as of 22:57, 26 August 2022
Line 24:		Line 24:

	<code>git init</code>		<code>git init</code>
		+
		+	this initialises the repository and adds a hidden <code>.git</code> directory which will contain the archived project versions.
		+
		+	=== 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.

	== Creating a RailOS Project with Git ==		== Creating a RailOS Project with Git ==

← Older revision		Revision as of 19:38, 26 August 2022
Line 18:		Line 18:

	== Introduction to Git CLI ==		== Introduction to Git CLI ==
		+
		+	=== Setting up Git in a 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:
		+
		+	<code>git init</code>

	== Creating a RailOS Project with Git ==		== Creating a RailOS Project with Git ==