git.lirion.de

Of git, get, and gud

summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormail_redacted_for_web 2021-05-05 15:07:16 -0700
committermail_redacted_for_web 2021-05-05 15:07:16 -0700
commita95701bce5aa5d9ef675171649ee106366c7c4a4 (patch)
treea7a5d050e7985ca529d962da1994d48d22ff0095 /README.md
parentfd89d9a7db7c675fddbb0957110a75d677cd1a9a (diff)
downloadcontrol-repo-template-a95701bce5aa5d9ef675171649ee106366c7c4a4.tar.bz2
Add template instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index 01940ae..b0ee178 100644
--- a/README.md
+++ b/README.md
@@ -95,7 +95,14 @@ To get started with using the control-repo template in your own environment and
### GitHub
-1. Prepare your local git client to authenticate with GitHub.com or a local GitHub Enterprise instance.
+Follow [GitHub's documentation](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) to create a your control repository starting from this template.
+
+<img width="429" alt="template button" src="https://user-images.githubusercontent.com/1392917/117215366-f4eeb280-adb2-11eb-9108-1bd45c4d98f3.png">
+
+
+### GitHub Enterprise
+
+1. Prepare your local git client to authenticate with a **local GitHub Enterprise instance**.
* <https://help.github.com/articles/generating-ssh-keys/>
* <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>
1. Create a repository called `control-repo` in your user account or organization. Ensure that "Initialize this repository with a README" is not selected.