.dotfiles _{Preferences, Installs, etc.}

Table of Contents

• About
• Prerequisites
• Getting Started
• Project Structure
• Tasks
• Credits

About

Personal collection of configurations for a system. Objective is to set up environment as easily as possible, especially on a new machine. Current supported platforms:

• macOS (10.13+)
• Linux
  • Debian (9.4+, WIP)
  • Ubuntu (18.04+)
  • Void

^{Back to top}

Prerequisites

• macOS
  • Apple Command Line Tools
• Linux
  • Make
  • Git
• Debian
  • sudo

^{Back to top}

Getting Started

1. Clone/download this repository.
   • Location matters as symlinks are generated
   • Use --recurse-submodules as this uses submodules
2. Use make to perform tasks. For a first-time install you should do the following:
   1. make install
   2. make symlink

^{Back to top}

Project Structure

Overview

COMING SOON

Domains

COMING SOON

Dependencies

COMING SOON

Symlinks

COMING SOON

^{Back to top}

Tasks

Tasks are defined in the Makefile that is to be used with Make.

make

List commands and options

make install

Install and set up dependencies

make symlink

Link dotfiles to required paths relative to $HOME

make update

Update this project and submodules

^{Back to top}

Credits

holman’s dotfiles

My first entry into dotfiles, some concepts inspired/copied here

^{Back to top}