From 8d30c01cf9ff2eb55e66930d38a70e48f33f3a89 Mon Sep 17 00:00:00 2001 From: Zachary Wartell <zwartell@uncc.edu> Date: Tue, 11 Feb 2025 12:10:39 -0500 Subject: [PATCH] -docs --- README.md | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 809ed5f..f567090 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,39 @@ -Instructions for a gradable Git Tutorial based on readings in https://git-scm.com/book/en/v2 plus varous Git 'best-practices' required in Dr. Wartell's course work and research projects. +# Git Tutorial +## Author: Zachary Wartell, Ph.D. -- WWW: https://webpages.charlotte.edu/zwartell/Teaching/Git%20Tutorial/Git%20Tutorial.html -- GIT: https://zwartell@gitlab.com/zwartell/Git_Tutorial_and_Coding_Standards.git \ No newline at end of file +<div><br> +License: +<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"> <img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png"></a> +<br> +<br> +</div> + +Instructions and interactive grading rubric for a Git tutorial based on readings in https://git-scm.com/book/en/v2 along with instructions for various Git 'best-practices' required in Dr. Wartell's course work and research projects. + +- WWW: + - https://webpages.charlotte.edu/zwartell/Teaching/Git%20Tutorial/Git%20Tutorial.html + - ...others... +- GIT: https://zwartell@gitlab.com/zwartell/Git_Tutorial_and_Coding_Standards.git + + +# Installation + +``` +[CLI Shell] +$ git clone https://zwartell@gitlab.com/zwartell/Git_Tutorial_and_Coding_Standards.git +$ git submodule init +$ git submodule update + +-[MS Windows] Run cmd.exe in administrator mode + -[cmd.exe] > www-site/git_modules/zjwgi/scripts/init-template.bat +-[other OS] reverse engineer and rewrite 'www-site/git_modules/zjwgi/scripts/init-template.bat' as a bash script, etc. + + +# Running Git Tutorial.html locally + +[Windows] Run "Git Tutorial.bat" + - software prerequisites : undocumented; see and decipher the .bat file +[Other] Install a webserver and serve the page 'Git Tutorial.html' on the localhost + +# Publishing Git Tutorial.html to a webserver +See and decipher file://./scripts/zjwgi/publishWWW \ No newline at end of file -- GitLab