Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
ApplicationCore
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ChimeraTK Mirror
ApplicationCore
Commits
30acd60f
Commit
30acd60f
authored
6 years ago
by
Martin Christoph Hierholzer
Browse files
Options
Downloads
Patches
Plain Diff
Removed HowTo_project-template.md
parent
550ee9d6
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
HowTo_project-template.md
+0
-63
0 additions, 63 deletions
HowTo_project-template.md
with
0 additions
and
63 deletions
HowTo_project-template.md
deleted
100644 → 0
+
0
−
63
View file @
550ee9d6
This file descibes the intended way to use the template project.
## Concept:
The project template is merged via git. The idea is to have the whole
project-template repository merged into the project which uses it, incl.
all the history. Like this updates and improvements in the template
scripts can easily be propagated to all client projects by simply
merging the head of project template.
## Instructions:
### Preparing your project to use the project template
-
Add the project template repository as a git remote to your project.
This only is done once for each local repository.
```
$ git remote add project-template https://github.com/ChimeraTK/project-template.git
```
We intentionally use the read-only https version here. Never write
to the project template from one of the client projects!
-
Update the remote on you hard disk so git knows what is in
project-template
```
$ git remote update
```
-
Merge the project template master into your project
```
$ git merge project-template/master
```
Note:you can access the files provided in the cmake directory from your
CMakeLists.txt after appending this location to your CMAKE_MODULE_PATH
variable
### Getting updates to the project template
```
$ git remote update
$ git merge project-template/master
```
If you are on a different computer with a different checkout directory which does not have the remote added
(check with 'git remote show'), you may have to repeat steps from the
section: Preparing your project to use the project template.
### Updating/Improving the project template.
-
Never write to the project template from one of the client projects! If
you have improvements or additions to the project template, check out
the project-template repository separately, make the modifications and
commit/push them.
-
Be careful not to break functionality for other project which are using
the template!
-
After the project template is updated you can merge the changes into
your project as described in the section above. (Getting updates of project template)
-
Note: For testing you might want to add your local repository of
project-template as a remote to your project, so you don't have to push
untested changes. Be careful that everything is pushed to github when
you are done in order not to lose consistency of the repositories.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment