diff --git a/README.md b/README.md index 45849b6..d741aa6 100644 --- a/README.md +++ b/README.md @@ -2,55 +2,30 @@ ## Installation +1. Install dependencies 1. Optionally create ~/.dotfiles.postinst -2. `bash <(curl -sL https://dotfiles.online)` (https://raw.githubusercontent.com/alopexc0de/dotfiles/master/install.sh) -3. ???? -4. Profit +1. `bash <(curl -sL https://dotfiles.online)` (https://c0de.dev/c0de/dotfiles/raw/branch/master/install.sh) +1. ???? +1. Profit -## Distro auto-install -This feature will install the basic dependencies automatically if you approve at the prompt, assumes that you have sudo access. +### Dependencies -These are pretty out of date like the dependencies list below. Your milage may vary if you choose to use the auto-install +I primarilarly use Arch, but these dotfiles also get installed to headless Debian servers. +It shouldn't be difficult to find an equilivant package for your distribution with the provided lists -Currently available for: -- Arch/Manjaro Linux (pacman+yay) -- Debian Linux (apt) +A list of the packages that I have installed can be found in the files `pacman.lst` and `pacman_aur.lst`. +Non-official packages come from the AUR, which can't typically be installed by pacman directly and the reason why it's a seperate list. -## Dotfiles Postinstall -You may create a standard text file called `.dotfiles.postinst` in your home directory before installing. -This file contains commands, one per line, that will be executed in order after the install script finishes. +### Dotfiles Postinstall + +You may create a standard text file called `.dotfiles.postinst` in your home directory before installing. +This file is basically a bash script that contains commands, that will be executed after the install script finishes. For example, you may want to add commands such as `git config --global user.name "My Name"` and `git config --global user.email "me@my.email"` ## Customizing Dotfiles + 1. Fork this repo 2. Update `repourl` inside install.sh to point to your own 3. Make your changes 4. Push to origin 5. Install your new dotfiles everywhere - -## Dependencies -My dotfiles now include my personalized i3 configuration if you also run the i3wm. -This is a bit outdated, so you can err on the side of caution and install other stuff as it's needed - -* [i3-gaps](https://github.com/Airblader/i3) WM -* [i3blocks](https://github.com/vivien/i3blocks) i3bar scheduler -* [i3lock-fancy](https://github.com/meskarune/i3lock-fancy) locker -* [rofi](https://github.com/DaveDavenport/rofi) launcher -* [Adobe's Source Code Pro](https://github.com/adobe-fonts/source-code-pro) font -* [terminator](https://wiki.archlinux.org/index.php/Terminator) terminal -* [feh](https://feh.finalrewind.org/) Image viewer/wallpaper -* [xcompmgr](https://wiki.archlinux.org/index.php/Xcompmgr) Compisiton Manager (window transparency) -* [maim](https://github.com/naelstrof/maim) Screenshot utility -* [powerline](https://wiki.archlinux.org/index.php/Powerline) -* [ntfy](https://github.com/dschep/ntfy) for Desktop Notifications - -## Branch Info - -This is the primary branch. -It includes changes that should be included in most, if not -all of the different configurations that may result of different -system use. - -For now, there are the master, macos and workpc branches. - -The workpc branch contains a lot of configuration from a base Manjaro install