search

clu-ling / clu-template

https://clu-ling.github.io/clu-template
0 stars 0 forks source link

Document post-creation steps #11

Open myedibleenso opened 3 years ago

myedibleenso commented 3 years ago

In post hook, print a description of next steps.

Docker

If docker enabled, ...

# change to new repo's directory
cd "{{cookiecutter.repo_name}}"
# initialize repository
git init
# switch to main branch
git checkout -b main
# add project files
git add . 
# install hub: https://github.com/github/hub#installation
# create an access token with repo scope: https://github.com/settings/tokens 
export GITHUB_TOKEN="my-token-here"
# create a private repository on GitHub from the command line (NOTE: omit -p to make public)
hub create -p "{{cookiecutter.organization}}/{{cookiecutter.repo_name}}"
# push initial version to remote
git push origin main

Pages

From repo settings, enable GH pages: https://github.com/{{cookiecutter.organization}}/{{cookiecutter.repo_name}}/settings/pages