From ec7726d5cada2836baa587f2a63bda32bd258bd0 Mon Sep 17 00:00:00 2001
From: Brandon Rodriguez <brodriguez8774@gmail.com>
Date: Thu, 10 Nov 2022 21:40:54 -0500
Subject: [PATCH] Improve general project documentation
---
readme.md | 20 ++++++++++++++++++++
run.sh | 2 +-
src/initialize_git.sh | 4 ++--
src/setup_npm.sh | 4 ++--
4 files changed, 25 insertions(+), 5 deletions(-)
diff --git a/readme.md b/readme.md
index eb1b13a..7279b16 100644
--- a/readme.md
+++ b/readme.md
@@ -3,3 +3,23 @@
## Description
Bash script to setup Linux after a fresh install.
+
+
+## Available options
+* Initialize Git (Git required for some other options)
+* Setup Local Database
+* Install/Update Npm & NodeJs
+
+### Initialize Git
+Very basic commands to setup git. Git is required for some of the other options.\n
+Plus it's just nice to immediately set up git for a new install.
+
+### Setup Local Database
+Installs and initializes a local database. Currently supported:
+* MySQL
+* MariaDB
+* Postgress not implemented but coming soon.
+
+### Install/Update Npm & NodeJs
+Installs/updates Npm to the latest LTS version.\n
+Also installs the `npm-check-updates` package, for quick and easy updating of local project dependencies.
diff --git a/run.sh b/run.sh
index 906e63b..c4f72f8 100755
--- a/run.sh
+++ b/run.sh
@@ -35,7 +35,7 @@ function main () {
# Display options.
echo ""
echo -e "${text_blue}Select an option:${text_reset}"
- echo -e "${text_cyan}1${text_reset}) Initialize Git"
+ echo -e "${text_cyan}1${text_reset}) Initialize Git (Git required for some other options)"
echo -e "${text_cyan}2${text_reset}) Setup Local Database"
echo -e "${text_cyan}3${text_reset}) Install/Update Npm & NodeJs"
echo -e "${text_cyan}0${text_reset}) Exit"
diff --git a/src/initialize_git.sh b/src/initialize_git.sh
index 7624f94..fcdfa38 100755
--- a/src/initialize_git.sh
+++ b/src/initialize_git.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
###
- # Run basic git initialization.
- # The commands are simple in themselves, but I tend to forget about them on initial install.
+ # Very basic commands to setup git. Git is required for some of the other options.
+ # Plus it's just nice to immediately set up git for a new install.
##
diff --git a/src/setup_npm.sh b/src/setup_npm.sh
index 091e769..253be3a 100755
--- a/src/setup_npm.sh
+++ b/src/setup_npm.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
###
- # Fully install + update npm.
+ # Installs/updates Npm to the latest LTS version.
# Because the commands are annoying to remember if you don't use them regularly.
# Also as of 2020/2021-ish, it seems like certain machine/installation setups are
# buggy to update without this exact command ordering.
@@ -62,7 +62,7 @@ function main () {
echo -e " ${text_purple}Npm Version${text_reset}: $(npm -v)"
echo -e " ${text_purple}React Version${text_reset}: $(npm view react version)"
echo ""
- echo -e "${text_blue}The npm-check-updates package has also been installed.${text_reset}"
+ echo -e "${text_blue}The {$text_purple}npm-check-updates${text_blue} package has also been installed.${text_reset}"
echo -e "${text_blue}This allows for quick package updating per-project.${text_reset}"
echo -e "${text_blue}Run ${text_cyan}ncu${text_blue} to see what can upgrade.${text_reset}"
echo -e "${text_blue}Run ${text_cyan}ncu -u${text_blue} to commit upgrades to project package.json file.${text_reset}"
--
GitLab