Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,47 @@ | ||
# FYP-Project-Template | ||
A Template for a student Final Year Project in Markdown | ||
|
||
|
||
# Installation | ||
## Requirements | ||
|
||
- Pandoc | ||
- Latex / PDFLatex | ||
- A Text Editor of your choice (Emacs / Notepad++) | ||
|
||
## Cloning this project | ||
|
||
The project makes use of git submodule functionality. Which means we need to clone the project in a slightly different way. | ||
|
||
This is as simple as cloning with the ```--recurse-submodules``` flag | ||
|
||
Command for this is: | ||
~~~ | ||
git clone --recurse-submodules git@github.coventry.ac.uk:aa9863/FYP-Project-Template.git | ||
~~~ | ||
|
||
## What to do if you did a standard Clone | ||
If we do a standard clone, then the Template directory exists but is empty. | ||
|
||
~~~ | ||
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). |