Skip to content
Permalink
Browse files
README updated
  • Loading branch information
aa9863 committed Jan 29, 2020
1 parent 80654e7 commit 621bf6aba392aef3eb9886b85b599c53dd4f538f
Showing 1 changed file with 8 additions and 25 deletions.
@@ -12,37 +12,20 @@ Documentation can be found [Here](https://github.coventry.ac.uk/aa9863/FYP-Proje

## Cloning this project

The project makes use of git submodule functionality. Which means we need to clone the project in a slightly different way.
> NOTE: Previously we used Submodules. I have now moved to using the
> new "Template" feature. If you have an older fork of the reposoty
> an this causes ytou issues please email me and let me know.
This is as simple as cloning with the ```--recurse-submodules``` flag
You can fork this reposiory as a "Template".

Command for this is:
~~~
git clone --recurse-submodules git@github.coventry.ac.uk:aa9863/FYP-Project-Template.git
~~~
1. On the main page of the Repository click "Use This Template"
1. A Template (think of this like a fork) is created, under your account.
1. Enjoy

## What to do if you did a standard Clone
If we do a standard clone, then the Template directory exists but is empty.
https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template

~~~
git clone git@github.coventry.ac.uk:aa9863/FYP-Project-Template.git
git submodule init
git submodule update
~~~

## Doing this in a GUI.

TODO: Get windows person to help

## Updating the Template Project

You shouldn't need to do this, but If i make changes to the base Template you can update the submodule

~~~
git submodule update --remote
~~~

## Why Submodules

This should mean the code is cleaner for your own repository.
Basically, all the template cruft will be sepereate (think of it as a library).

0 comments on commit 621bf6a

Please sign in to comment.