INSTALL.md

Installing mkproj

mkproj is a family of three Bash functions.

Files to be installed

$ mkproj <-- parent function
$ mkvenv <-- child function #1
$ mkrepo <-- child function #2

Compatibility

The functions have been tested in GNU Bash, version 5.0.17 on Ubuntu 20.04. They should work in other Bash 5.0+ environments (assuming Python 3.5+, Git, and Curl are installed).

Dependencies

• Python 3.5+ (tested with Python 3.8.5)
• Python venv module
• Git
• A GitHub account with
  • a Personal Access Token
  • a Template Repository
• Curl

Bash environment variables needed for connecting to the GitHub API:

(define these in the ~/.bashrc file)

• GITHUB_USERNAME
• GITHUB_TOKEN
• GITHUB_TEMPLATE_REPO (the name of a template repository)

To install $ mkproj, $ mkvenv, and $ mkrepo:

1. Fork the mkproj repo to your GitHub account.

2. Clone the mkproj repo from your GitHub account to your local drive.

3. Copy the mkproj, mkvenv, and mkrepo files into a ~/<directory> of your choice.

4. Add the following to the ~/.bashrc file:

   • source ~/<directory>/mkproj
   • source ~/<directory>/mkvenv
   • source ~/<directory>/mkrepo

5. You will have to restart the shell or run $ source ~/.bashrc for the functions to take effect.