Alexander/LARBS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: Introduce aesthetic improvements

Browse Source 
- Create a table of contents
 - Limit the width of each line to a maximum of 80 characters
   (makes the file more vim-friendly to edit)
 - Add shell's syntax highlight in code samples
This commit is contained in:
Caian R. Ertl 2017-11-24 02:04:35 -02:00
parent fb603d57ff
commit 6dafae299f
No known key found for this signature in database
GPG Key ID: 792821A68EC0A52E
1 changed files with 99 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
docs/README.md
View File

@ -2,48 +2,95 @@
[Official Website: larbs.xyz](http://larbs.xyz) [Official Website: larbs.xyz](http://larbs.xyz)
This is a set of scripts either can either (1) install Arch Linux automatically with a typical Arch ISOed USB, and perhaps more prominently (2) automatically install and configure all of the prerequisites for an advanced Linux desktop environment, using my configs [here](https://github.com/LukeSmithxyz/voidrice) as a base. This is a set of scripts either can either (1) install Arch Linux automatically
with a typical Arch ISOed USB, and perhaps more prominently (2) automatically
install and configure all of the prerequisites for an advanced Linux desktop
environment, using my configs [here](https://github.com/LukeSmithxyz/voidrice)
as a base.
Really, the goal of this script is to start a kind of Linux meta-distribution which makes the more nuanced aspects of an advanced Linux setup available to even Linux newbies. Of course, it's also a great tool for advanced users who want to get into tiling window managers and just generally cool-looking and efficient worksetups.
All the core stuff we be installed without prompt, but you'll have the option to install some of the larger non-essential packages (LaTeX, LibreOffice, Blender, etc.). ## Table of Contents
- [About](#about)
- [Installation](#installation)
- [On an already existing Arch install](#on-an-already-existing-arch-install)
- [Installing Arch automatically](#installing-arch-automatically)
- [How to Use](#how-to-use)
- [Permission Details (sudoers file)](#permission-details-sudoers-file)
- [Version](#version)
- [Why I made this](#why-i-made-this)
- [Bugs?](#bugs)
## About
Really, the goal of this script is to start a kind of Linux meta-distribution
which makes the more nuanced aspects of an advanced Linux setup available to
even Linux newbies. Of course, it's also a great tool for advanced users who
want to get into tiling window managers and just generally cool-looking and
efficient worksetups.
All the core stuff we be installed without prompt, but you'll have the option
to install some of the larger non-essential packages (LaTeX, LibreOffice,
Blender, etc.).
## Installation ## Installation
### Installing my setup on an already existing Arch install ### On an already existing Arch install
This is just as easy. Log in as the root user and run the following. This is just as easy. Log in as the root user and run the following.
``` ```sh
curl -O http://larbs.xyz/larbs.sh #Downloads the script. curl -O http://larbs.xyz/larbs.sh #Downloads the script.
bash larbs.sh #Runs it. bash larbs.sh #Runs it.
``` ```
After prompting you for some settings and some package choices, the system will install my full i3-gaps tiling window manager Desktop Environment. If you don't know what that means, don't worry, because I've gone to great lengths to write readable instructions about how to go PRO super quick with this system. After prompting you for some settings and some package choices, the system will
install my full i3-gaps tiling window manager Desktop Environment. If you don't
know what that means, don't worry, because I've gone to great lengths to write
readable instructions about how to go PRO super quick with this system.
Finally, it will use `git` to download my [Voidrice](https://github.com/lukesmithxyz/voidrice) dotfiles and will plop them in their proper location for instant use! Finally, it will use `git` to download my
[Voidrice](https://github.com/lukesmithxyz/voidrice)
dotfiles and will plop them in their proper location for instant use!
Then, finally, once that all is done, you should be able to log out, then log in as your newly created user and type `startx` to begin the graphical environment. Congrats! Then, finally, once that all is done, you should be able to log out, then log in
as your newly created user and type `startx` to begin the graphical environment.
Congrats!
### Installing Arch automatically
### Installing Arch Automatically I also have a script here for installing Arch automatically. I *only* wrote this
script so I could quickly install then test the other scripts on new computers,
but theoretically you could use it as well. *BUT* this is a lazy, pre-alpha
script which does not give you many options (it automatically chooses the New
York time zone, US English, GRUB, Network Manager, etc). Even more important, it
automatically partitions /dev/sda without asking, so unless, you have no
non-backed up data on your machine, I don't advise running it unless you don't
mind a full wipe. That said, you can run it like this after booting into an Arch
live environment:
I also have a script here for installing Arch automatically. I *only* wrote this script so I could quickly install then test the other scripts on new computers, but theoretically you could use it as well. *BUT* this is a lazy, pre-alpha script which does not give you many options (it automatically chooses the New York time zone, US English, GRUB, Network Manager, etc). Even more important, it automatically partitions /dev/sda without asking, so unless, you have no non-backed up data on your machine, I don't advise running it unless you don't mind a full wipe. That said, you can run it like this after booting into an Arch live environment: ```sh
```
curl -O http://larbs.xyz/arch.sh #Downloads the script. curl -O http://larbs.xyz/arch.sh #Downloads the script.
bash arch.sh #Runs it. bash arch.sh #Runs it.
``` ```
After the system installs, you'll have the option of bootstrapping automatically into installing my configs as well. After the system installs, you'll have the option of bootstrapping automatically
into installing my configs as well.
## How to Use ## How to Use
Once you're in the environment, just type Super/Mod/Windows+F1 to pull up a document that will explain everything. Once you're in the environment, just type `Super` / `Mod` / `Windows` + `F1` to
pull up a document that will explain everything.
## Permission Details (sudoers file) ## Permission Details (sudoers file)
These script will give your new created user (and those others you put in the `wheel` group) sudo access (with a password), but will also allow some commands to be run without any password confirmation. Those include: These script will give your new created user (and those others you put in the
`wheel` group) sudo access (with a password), but will also allow some commands
to be run without any password confirmation. Those include:
+ `shutdown` + `shutdown`
+ `reboot` + `reboot`
@ -53,30 +100,58 @@ These script will give your new created user (and those others you put in the `w
+ `umount` + `umount`
+ `systemctl restart NetworkManager` + `systemctl restart NetworkManager`
Additionally, if you've put your password in a terminal window already, you will not need to repeat putting it in in other terminal windows. Additionally, if you've put your password in a terminal window already, you will
not need to repeat putting it in in other terminal windows.
## Version ## Version
We're basically on Version 2.0 now, which is still pretty primitive. I'm adding some error handling, if the script fails, check the contents of LARBS.log in whatever directory you've run the script. Still, this script is still in the Wild West, so I recommend only running it on fresh installs. We're basically on Version 2.0 now, which is still pretty primitive. I'm adding
some error handling, if the script fails, check the contents of LARBS.log in
whatever directory you've run the script. Still, this script is still in the
Wild West, so I recommend only running it on fresh installs.
## Why I made this ## Why I made this
When you've installed Arch Linux 6 gorrillian times like me, you get pretty sick of having to reproduce your favorite configuration on fresh installs over and over. When you're a C-list YouTube celebrity, it gets even more difficult when literally thousands of people ask you how to do X or get Y. When you've installed Arch Linux 6 gorrillian times like me, you get pretty sick
of having to reproduce your favorite configuration on fresh installs over and
over. When you're a C-list YouTube celebrity, it gets even more difficult when
literally thousands of people ask you how to do X or get Y.
The LARBS are a final solution to all of that. These scripts are to be run on a fresh install of Arch Linux, and they create a user, install all required programs and set up dotfiles directly from Github to give normal people a fairly sleek Linux configuration without hundreds of autsitic hours. I did the work, so why should you? The LARBS are a final solution to all of that. These scripts are to be run on a
fresh install of Arch Linux, and they create a user, install all required
programs and set up dotfiles directly from Github to give normal people a fairly
sleek Linux configuration without hundreds of autsitic hours. I did the work, so
why should you?
I've also documented the configuration fairly well, check out the documentation
on my **voidrice** repository for that.
I've also documented the configuration fairly well, check out the documentation on my **voidrice** repository for that.
## Bugs? ## Bugs?
### When I type `startx` I get some kind of non-descript error! ### When I type `startx` I get some kind of non-descript error!
Some computers might require some additional drivers to run a graphical environment, for example, some ThinkPads might require you to install `xf86-video-intel`. If you search your model or graphics card along with "Arch Linux" on your preferred search engine, you'll probably get the answer fast. Some computers might require some additional drivers to run a graphical
environment, for example, some ThinkPads might require you to install
`xf86-video-intel`. If you search your model or graphics card along with "Arch
Linux" on your preferred search engine, you'll probably get the answer fast.
### I have some other problem and it didn't install correctly. ### I have some other problem and it didn't install correctly.
In normal circumstances, there are two main causes of misinstalls: faulty internet connections and errors with particular package upgrades or with the pacman keyring. Check yourself if the former may be at fault, but feel free to inform me in the latter case; I may be able to provide a quick fix. In normal circumstances, there are two main causes of misinstalls: faulty
internet connections and errors with particular package upgrades or with the
pacman keyring. Check yourself if the former may be at fault, but feel free to
inform me in the latter case; I may be able to provide a quick fix.
### >still using systemd botnet distro and/or not a 100% free-as-in-freedumb Parabola GANOO slash Linocks ### >still using systemd botnet distro and/or not a 100% free-as-in-freedumb
Parabola GANOO slash Linocks
I do plan on making an alternative script option for Parabola sooner or later,
after all Parabola *is* the distro I actually use. If you want to use Arch
OpenRC or another Arch-based non-systemd distro, I think this script still
*should* work, although you may have to manually enable Network Manager or
Pulseaudio. I haven't tested this though. If you have, tell me the results and
I might implement it.
I do plan on making an alternative script option for Parabola sooner or later, after all Parabola *is* the distro I actually use. If you want to use Arch OpenRC or another Arch-based non-systemd distro, I think this script still *should* work, although you may have to manually enable Network Manager or Pulseaudio. I haven't tested this though. If you have, tell me the results and I might implement it.