docs: Update README

This commit is contained in:
Donovan Glover 2018-12-11 15:42:06 -05:00
parent 54c2f73d67
commit 4dfbc5d469
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65

View File

@ -2,16 +2,26 @@
> TODO: Screenshots
## What is an operating system?
An operating system is a collection of software. Every operating system builds off of the work of many other individuals and their respective creations (the "software"). This is how systems work, and is not unique to operating systems nor computing itself.
GNU/Linux is a collection of software that most modern free operating systems use. Note that a significant amount of non-GNU/Linux software, such as systemd, Xorg, and other software, is used to make a complete GNU/Linux distribution.
## Usage
### Replicate my [Arch Linux](/.archlinux) setup
Note that if you already have an Arch Linux install and just want my look, you can simply install the necessary software and use my dotfiles with them.
On a fresh [Arch Linux][archlinux] install, run the bootstrap script.
```sh
git clone https://github.com/GloverDonovan/.files --depth 1 && ./.files/.archlinux/bootstrap.sh
```
> **Note**: My [install scripts](./.archlinux/install-scripts) may be of use to you, but remember to add what you need and change what you don't want as needed.
### Replicate my [Fedora](/.fedora) setup
On a fresh [Fedora][fedora] install, run the bootstrap script.
@ -20,6 +30,8 @@ On a fresh [Fedora][fedora] install, run the bootstrap script.
git clone https://github.com/GloverDonovan/.files --depth 1 && ./.files/.fedora/bootstrap.sh
```
> **Note**: If you just want my Fedora look, run the [make rice](./.fedora) target.
### Use only the dotfiles you want
#### Method 1. With [`stow`][stow]
@ -48,6 +60,20 @@ If you already have dotfiles and want to improve them, you can use this reposito
If you don't want to use stow, you can simply copy/paste the dotfiles you want to their relevant directories.
## Making changes
To change the settings used by a certain program, simply edit the necessary dotfiles for that program.
### Arch Linux
To change how the Arch Linux installation process works, simply edit the files in `.archlinux` before you run `bootstrap.sh`.
If you want to use [Tari](./.archlinux/PKGBUILDs) but don't want to use all the packages, simply remove the lines of packages that you don't need in the `PKGBUILD` before installing it.
### Fedora
To change how the Fedora installation process works, simply edit the files in `.fedora` before you run `bootstrap.sh`.
## Updating
To update your system with any changes I make, you must first verify that the changes I made are actually changes you want. Eventually I want to consider my dotfiles "stable" (i.e. 1.0.0, 2.0.0, etc.) in which only major version upgrades would significantly alter existing functionality, but right now this simply isn't the case.