diff --git a/README.org b/README.org index 3bfb753..abb076f 100644 --- a/README.org +++ b/README.org @@ -6,6 +6,8 @@ CBSH, or Cabooshy's Shell, is a Post installation Script for Arch Linux, and Arc * TABLE OF CONTENTS :toc: - [[#about-cbsh][About CBSH]] + - [[#current-list-of-arch-distros-that-i-have-tested-cbsh-on-and-it-works-fine][Current List of Arch distros that i have tested CBSH on and it works fine:]] + - [[#list-of-arch-distros-this-wont-work-on][List of Arch distros this won't work on:]] - [[#installing-cbsh][Installing CBSH]] - [[#install-instructions][Install Instructions]] - [[#potential-bugs][Potential Bugs]] @@ -32,6 +34,18 @@ CBSH, or Cabooshy's Shell, is a Post installation Script for Arch Linux, and Arc * About CBSH Cabooshy's Shell (CBSH) is a Post Install Script for Arch Linux and Arch based Distro's, it installs my Qtile Desktop, and programs i use on a daily basis, like Emacs. +This Postinstall script is largely based on/inspired by [[https://gitlab.com/dtos/dtos][DTOS]] by Derek Taylor (Distrotube on YT!) +I've been wanting to do something like this for the longest time and my journey into Arch and wanting to know more about packaging my own stuff and that led me to making this. i felt i'd learn more doing it myself with my own setup instead of tweaking DTOS to my own liking, lots of how this script works is very similar to DTOS. + +** Current List of Arch distros that i have tested CBSH on and it works fine: +- Arch Linux (No Brainer) +- Arcolinux +- Manjaro Linux + +this list will get bigger as i test more distros. + +** List of Arch distros this won't work on: +- Artix Linux -- Due to the majority of distros using systemd, this script assumes its installed, and as Artix doesnt use systemd, it wont work, i may make varients of the script that work on artix (to cover all the possible bases of init systems you can choose), but its unlikely as i don't use Artix. * Installing CBSH ** Install Instructions @@ -82,12 +96,12 @@ Many of CBSH's Packages are actually configuration files, these will get stored * Contributing to CBSH -Contributions from other people are welcomed. especially for distro's i have no experience with, like Fedora, but there are a few things you will need to consider before making a merge request. +Contributions from other people are welcomed, but there are a few things you will need to consider before making a merge request. ** Edit The README.org -I get some people are not well versed in the emacs way of doing things, but this very readme is the postinstall script. Utilising ORG-Mode's magic, i convert the ~README.org~ into both ~cbsh~ scripts. So by editing the main scripts directly and making a merge request, especially for huge changes, makes a lot more work than what is needed, as i'd have to manually edit the ~README.org~ to make it conform to the changes you proposed in your merge request. So please, edit the ~README.org~. +I get some people are not well versed in the emacs way of doing things, but this very readme is the postinstall script. Utilising ORG-Mode's magic, i convert the ~README.org~ into the ~cbsh~ script. So by editing the main scripts directly and making a merge request, especially for huge changes, makes a lot more work than what is needed, as i'd have to manually edit the ~README.org~ to make it conform to the changes you proposed in your merge request. So please, edit the ~README.org~. -I Will include a conversion script for non emacs users so they can edit the corresponding (or new!) ~README.org~ with whatever Text-Editor/IDE they want, and then convert it into the script to see if it exports correctly. +As this script is similar to DTOS, DT's [[https://gitlab.com/dtos/dtos/-/blob/master/convert.sh][Conversion Script]] will work to convert my readme to a shell script you can use to test changes. ** TEST. YOUR. CHANGES. LOCALLY. FIRST. It would be a very, very good idea to have a local VM with a clean installation of your distro of choice, and clone the clean VM when you need to test the script. Please don't make a merge request without actually testing your changes first in a ~fresh VM~ (One you have not run the script on before). @@ -195,7 +209,7 @@ recieve_keys || err "Error Recieving PGP key $_pgpkey" * Installing the packages from the repos -All packages listed are either in the standard Arch Repos or in my CBSH repos. these will all get installed with pacman. the only exception is DOOM Emacs which will be installed later in the script. +All packages listed are either in the standard Arch Repos, Repos provided by the likes of Manjaro, Arco etc. or in my CBSH repos. these will all get installed with pacman. the only exception is DOOM Emacs which will be installed later in the script. ~NOTE:~ The `-ask 4` option tells pacman that all questions regarding removing conflicting packages are automatically answered YES @@ -206,6 +220,7 @@ sudo pacman --needed --ask 4 -Syu - < pkglist.txt # Now that pikaur is installed, we can sync the AUR and install some needed packages (Nerd Fonts) from there. pikaur -Syu nerd-fonts-source-code-pro nerd-fonts-fira-code librewolf-bin #+end_src +~NOTE:~ On Arco, SourceCodePro and Librewolf are in their repos, and will be installed from there instead of the AUR. * Choosing Graphics Drivers By Default, the script normally installed the Nvidia Drivers, due to me using a Nvidia GPU, but recently i've realised it would be a much better idea to allow the user to install the relevant drivers based on what they use (Intel HD/Iris/Xe Graphics, AMD Graphics, Nvidia Graphics) instead of just installing the Nvidia Drivers if they don't use a Nvidia card. @@ -243,7 +258,9 @@ select choice in "${shells[@]}"; do ;; esac done -echo "NOTE: Currently, the nvidia-open drivers have an issue where they do not work on systems with AMD APUs, such as the Laptop Ryzen chips (C/U/H/HS/HX), or the Ryzen 2/3/4/5000 Series G Families of chips on the desktop, please use the closed source drivers instead to make sure you have a working system." +echo "NOTE: Currently, the nvidia-open drivers have an issue where they do not work on systems with AMD APUs, +such as the Laptop Ryzen chips (C/U/H/HS/HX), or the Ryzen 2/3/4/5000 Series G Families of chips on the desktop, +please use the closed source drivers instead to make sure you have a working system." #+end_src * Copying over the configs from /etc/cbsh to $HOME