From 720712b25ae027ba4e5fd5bac260a0ab4ea48bac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petar=20Kapri=C5=A1?= Date: Wed, 23 Apr 2025 14:54:40 +0200 Subject: [PATCH] Complete README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7da88f..3ab1a56 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ # Kayprish's bootstrap script +BS is a simple bootstrap script which I use to make sure I have all the +packages I'll ever need on a given system. The only requirements are a +bare-bones Artix install (although with changes to the progs file it could also +work with Arch), an internet connection, and root access to the system. + +It will setup a new user for you (or modify the current one), enable all the +necessary repos, install all of the selected packages, and make a few tweaks to +the system configuration (you can read the script for details, it's not that +long). + +## Running the script +If you have an internet connection, and are root on your bare bones system, you can simply run: +```bash +curl -LO https://git.bonsai.cool/kayprish/bs/raw/branch/master/bs.sh +sh bs.sh +``` + +The script will take around 10-20 minute-ish with a good internet connection. + +It installs Hyprland as your wayland compositor, so once you're done you can log in as your main user, and run `Hyprland` to use it. + Based on LARBS. ## TODO's: @@ -8,4 +29,4 @@ Based on LARBS. - [X] Also all of the pacman commands could be smushed into one - [X] Show what's actually going on - [X] Include the GPLv3 in the source -- [ ] Make a proper README +- [X] Make a proper README