Complete README

This commit is contained in:
Petar Kapriš 2025-04-23 14:54:40 +02:00
parent d403ef6984
commit 720712b25a

View file

@ -1,5 +1,26 @@
# Kayprish's bootstrap script # 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. Based on LARBS.
## TODO's: ## TODO's:
@ -8,4 +29,4 @@ Based on LARBS.
- [X] Also all of the pacman commands could be smushed into one - [X] Also all of the pacman commands could be smushed into one
- [X] Show what's actually going on - [X] Show what's actually going on
- [X] Include the GPLv3 in the source - [X] Include the GPLv3 in the source
- [ ] Make a proper README - [X] Make a proper README