Allow function to be called.

[dotfiles.git] / README.md

diff --git a/README.md b/README.md
index faadbd4dd965c94b0f69a43aca47fdd9ae7b0aa5..3d376e65ba00e1e6e82d9a4e8b9002cf83b7a574 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,22 @@
 # dotfiles
-My Linux dot files.
 
-# Setup
-Copy the file `setup.sh` to the destination system.
-Source it there.
+EdTheDev's Linux and Windows dot files. These are shared so that I can easily share a link to a tip or trick.
 
-Make sure your shell is set to PowerShell
+## Bare Minimum
+
++ `install.sh` - Script I use to install packages on Linux, most typically a Raspberry Pi. 
++ `setup.sh` - Script I use to get to bare minimum (by my definition) setup on Linux - typically a Raspberry Pi.
++ `bootstrap.ps1` - Script I use to setup on Windows. Mostly relies on the `Chocolatey` package manager for Windows, of course.
+
+## Installations
+
+See the `\install` folder for scripts to install various handy utilities. Most of these rely on `Apt` on Linux, or `Chocolatey` on Windows.
+
+## Setups
+
+See the `\setup` folder for configurations.
+These are, obviously, just my preferred configurations.
+
+In general, these work by setting up symlinks on Linux, and on Windows by copying a stub file that sources the versioned file. 
+
+Most of these are cross platform `.ps1` files that run under PowerShell.