Merge branch 'documentation-updates' into 'main'

Documentation updates

See merge request ahoneybun/nyxi-installer!12

README.md

@@ -6,8 +6,9 @@ At the core of this installer it does the following:
 
 - Partition the drive of your choice
 - Installs a base of NixOS (`configuration.nix`)
-- Installs Plasma (`plasma.nix`)
+- Installs a DE/WM of your choice (currently supporting GNOME and Plasma)
 - Installs needed packages (`programs.nix`)
+- Installs needed packages for certain hardware 
 
 nix files are from [this repo](https://gitlab.com/ahoneybun/nix-configs/) but that can be changed as needed.
 

install.sh

@@ -1,4 +1,5 @@
-# Figure out how much RAM the system has an set a variable
+# Figure out how much RAM the system has 
+# then sets it as a variable for hibernation support
 ramTotal=$(free -h | awk '/^Mem:/{print $2}'| awk -FG {'print$1'})
 
 # Detect and list the drives.
@@ -105,7 +106,12 @@ sudo mount $efiName /mnt/boot
 # Generate Nix configuration
 sudo nixos-generate-config --root /mnt
 
-# Copy my nix configs over
+# Copy my base nix configs over
+# Change the URL to match where you are hosting your .nix file(s).
+
+echo "Default username and password are in the configuration.nix file"
+echo "Password is hashed so it is not plaintext"
+
 curl https://gitlab.com/ahoneybun/nix-configs/-/raw/main/configuration.nix > configuration.nix; sudo mv -f configuration.nix /mnt/etc/nixos/
 curl https://gitlab.com/ahoneybun/nix-configs/-/raw/main/programs.nix > programs.nix; sudo mv -f programs.nix /mnt/etc/nixos/
 
@@ -115,6 +121,9 @@ echo "1) Plasma"
 echo "2) GNOME"
 read desktopChoice
 
+# Change the URL to match where you are hosting your DE/WM .nix file
+# Update the second command to the file name that matches your DE/WM .nix file
+
 if [ $desktopChoice = 1 ]; then
    curl https://gitlab.com/ahoneybun/nix-configs/-/raw/main/plasma.nix > plasma.nix; sudo mv -f plasma.nix /mnt/etc/nixos/
    sudo sed -i "10 i \            ./plasma.nix" /mnt/etc/nixos/configuration.nix
@@ -131,14 +140,18 @@ echo ""
 echo "Which device are you installing to?"
 echo "1) Oryx Pro (oryp6)"
 echo "2) HP Omen (15-dh0015nr)"
-read device
+echo "0) None or N/A"
+read deviceChoice
 
-if [ $device = 1 ]; then
+# Change the URL to match where you are hosting your system .nix file
+# Update the second command to the file name that matches your system .nix file
+
+if [ $deviceChoice = 1 ]; then
    curl https://gitlab.com/ahoneybun/nix-configs/-/raw/main/systems/oryp6.nix > oryp6.nix; sudo mv -f oryp6.nix /mnt/etc/nixos/
    sudo sed -i "10 i \            ./oryp6.nix" /mnt/etc/nixos/configuration.nix 
 else
 
-if [ $device = 2 ]; then
+if [ $deviceChoice = 2 ]; then
    curl https://gitlab.com/ahoneybun/nix-configs/-/raw/main/systems/hp-omen.nix > hp-omen.nix; sudo mv -f hp-omen.nix /mnt/etc/nixos/
    sudo sed -i "11 i \            ./hp-omen.nix" /mnt/etc/nixos/configuration.nix 
 fi

setup.sh

@@ -1,12 +0,0 @@
-# Set user password
-echo "----------"
-echo ""
-echo "Which is the username?"
-read userName
-
-sudo passwd $userName
-
-# Create Directories
-mkdir /home/$userName/Projects
-
-exit