/quickstart

Boilerplate for a repo with quickstart supporting `curl | bash` syntax

Primary LanguageShellMIT LicenseMIT

quickstart

Boilerplate for a repo with quickstart supporting curl | bash syntax

Quick Start

  • In your repo:
    • Create a file called setup.sh at the base of your repo
      • This bash script should do all the work of installing your repo
      • Ensure setup.sh is executable
    • Copy the lines below into your README
    • Replace QS_GIT_REPO with your repo url
export QS_GIT_REPO=https://github.com/andylytical/quickstart
#export QS_GIT_BRANCH=branch_name  #optional - specify a branch other than main
curl https://raw.githubusercontent.com/andylytical/quickstart/main/quickstart.sh | bash

Example Usage

export QS_GIT_REPO=https://github.com/andylytical/quickstart
#export QS_GIT_BRANCH=branch_name  #optional - specify a branch other than main
curl https://raw.githubusercontent.com/andylytical/quickstart/main/quickstart.sh | bash
  • Copy/paste the above lines in your Bash terminal window
  • Expected output:
Hello from '/tmp/tmp.81DzXvvQ6s/setup.sh'
Install dir: '/home/aloftus/junk'
Nothing else to do.