diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 26 insertions, 10 deletions
@@ -14,22 +14,38 @@ system, unlike LARBS, which is agnostic. On Artix (with runit as init), run the following as root: ``` -sh larbs.sh +sh zirless.sh ``` That's it. -## What is LARBS? +## What is ZIRLESS -LARBS is a script that autoinstalls and autoconfigures a fully-functioning +ZIRLESS 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. +ZIRLESS can be run on a fresh install of Artix Linux, and provides you with a +fully configured diving-board for work or more customization. + +NOTE: ZIRLESS expects the following packages, metapackages, and groups to be +installed: + +- base +- git +- a linux kernel, plus its headers +- the runit init system (unless you provide your own progs.csv) +- a network connection and manager (dhcpcd, wpa_supplicant, networkmanager, etc) + +ZIRLESS also assumes the following about the other files: + +- progs.csv should have AUR packages after any optional build dependencies +- if the users dotfiles repo needs to install anything into the home dir, it + should have a Makefile, and `make install` should install these files (or the + user should expect to do it manually). ## Customization -By default, LARBS uses the programs [here in progs.csv](progs.csv) and installs +By default, ZIRLESS uses the programs [here in progs.csv](progs.csv) and installs [my dotfiles repo (dotfiles) here](https://gitlab.com/zachir/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: @@ -41,7 +57,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 +ZIRLESS 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, "" @@ -50,12 +66,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, ZIRLESS 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. ZIRLESS 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. @@ -71,7 +87,7 @@ 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 +ZIRLESS 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, |