aboutsummaryrefslogtreecommitdiff
path: root/tools/git-bootstrap/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'tools/git-bootstrap/README.org')
-rw-r--r--tools/git-bootstrap/README.org13
1 files changed, 13 insertions, 0 deletions
diff --git a/tools/git-bootstrap/README.org b/tools/git-bootstrap/README.org
new file mode 100644
index 0000000..74ced1b
--- /dev/null
+++ b/tools/git-bootstrap/README.org
@@ -0,0 +1,13 @@
+#+TITLE: git-bootstrap
+
+Bootstrap a new git repository with a license, readme, and create a remote repository on GitHub.
+
+* GitHub
+When running the command, a new remote repository is created on GitHub when a token is present in the git configuration, under github.bootstrap.
+
+To create a token:
+1. go to https://github.com/settings/tokens
+2. create a token with the scope for repo
+3. store the token with =git config --global github.bootstrap <token>=
+
+To skip the creation of a repository on GitHub: =git-bootstrap -no-github <repo name>=