luca
/
bootstrapper
1
0
Fork 0
Code

update readme

This commit is contained in:
Luca Bilke 2022-08-23 21:25:50 +02:00
parent d0e8deb6ea
commit 40964722b9
1 changed files with 14 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,28 +1,19 @@
# Luke's Auto-Rice Bootstrapping Scripts (LARBS)
# Bootstrapping script (Based off of LARBS)
## Installation:
On an Arch-based distribution as root, run the following:
```
curl -LO larbs.xyz/larbs.sh
curl -LO https://git.snaile.de/luca/bootstrapper/raw/branch/main/larbs.sh
sh larbs.sh
```
That's it.
## What is LARBS?
LARBS is a script that autoinstalls and autoconfigures a fully-functioning
and minimal terminal-and-vim-based Arch Linux environment.
LARBS can be run on a fresh install of Arch or Artix Linux, and provides you
with a fully configured diving-board for work or more customization.
## Customization
By default, LARBS uses the programs [here in progs.csv](progs.csv) and installs
[my dotfiles repo (voidrice) here](https://github.com/lukesmithxyz/voidrice),
By default, the script uses the programs [in progs.csv](progs.csv) and installs
[my dotfiles repo](https://git.snaile.de/luca/dotfiles),
but you can easily change this by either modifying the default variables at the
beginning of the script or giving the script one of these options:
@ -33,7 +24,7 @@ beginning of the script or giving the script one of these options:
### The `progs.csv` list
LARBS will parse the given programs list and install all given programs. Note
The script will parse the given programs list and install all given programs. Note
that the programs file must be a three column `.csv`.
The first column is a "tag" that determines how the program is installed, ""
@ -42,12 +33,12 @@ git repository that is meant to be `make && sudo make install`ed.
The second column is the name of the program in the repository, or the link to
the git repository, and the third column is a description (should be a verb
phrase) that describes the program. During installation, LARBS will print out
phrase) that describes the program. During installation, the script will print out
this information in a grammatical sentence. It also doubles as documentation
for people who read the CSV and want to install my dotfiles manually.
Depending on your own build, you may want to tactically order the programs in
your programs file. LARBS will install from the top to the bottom.
your programs file. The script will install from the top to the bottom.
If you include commas in your program descriptions, be sure to include double
quotes around the whole description to ensure correct parsing.
@ -62,11 +53,10 @@ through the programs file and determines based on the tag of each program,
which commands to run to install it. You can easily add new methods of
installations and tags as well.
Note that programs from the AUR can only be built by a non-root user. What
LARBS does to bypass this by default is to temporarily allow the newly created
user to use `sudo` without a password (so the user won't be prompted for a
password multiple times in installation). This is done ad-hocly, but
effectively with the `newperms` function. At the end of installation,
`newperms` removes those settings, giving the user the ability to run only
several basic sudo commands without a password (`shutdown`, `reboot`,
`pacman -Syu`).
Note that programs from the AUR can only be built by a non-root user.
This script bypasses this by temporarily allowing the newly created user
to use `sudo` without a password (so the user won't be prompted for a password
multiple times in installation). This is done ad-hocly, but effectively with
the `newperms` function. At the end of installation, `newperms` removes those
settings, giving the user the ability to run only several basic sudo commands
without a password (`shutdown`, `reboot`, `pacman -Syu`).