https://github.com/jamesridgway/dotfiles

This repository contains the dotfiles and configuration for tools that I use
https://github.com/jamesridgway/dotfiles

dotfiles dotfiles-setup

Last synced: 10 days ago
JSON representation

This repository contains the dotfiles and configuration for tools that I use

• Host: GitHub
• URL: https://github.com/jamesridgway/dotfiles
• Owner: jamesridgway
• Created: 2017-10-28T16:04:18.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T18:41:54.000Z (10 months ago)
• Last Synced: 2024-05-01T15:02:36.830Z (6 months ago)
• Topics: dotfiles, dotfiles-setup
• Language: Shell
• Size: 209 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dotfiles

[![CI](https://github.com/jamesridgway/dotfiles/actions/workflows/ci.yml/badge.svg)](https://github.com/jamesridgway/dotfiles/actions/workflows/ci.yml)

Your dotfiles are how you personalise your system. These are mine,

I grew tired of having to setup and customise my system to suit my needs everytime I re-installed or switched to a new machine.

This dotfiles repository aims to eliminate the need for any manual configuration. Keeping configurations in-sync between machines is now also effortless.

![Dotfiles setup script screenshhot](https://files.jamesridgway.co.uk/dotfiles.gif)

## Approach

There is a single `./setup` script which is run as the installation process. This script will apply any changes.

This is largely achieved by symlinking dotfiles in this repository to those in the home directory.

This repository has been broken down into a folder structure for each tool that I use.

## Installation

Run:

    curl -sSL https://jmsr.io/dotfiles.sh | bash

Or, if you have cloned the repository run `./setup`.

## Components

In most cases, each tool has it's own folder, which is true of:

* gradle

* terminator

* tmux

* vim

* zsh

There is also a `scripts` directory which is a submodule of my [scripts](https://github.com/jamesridgway/scripts) repository. Anything in the scripts submodule is added to my `PATH` variable by symlinking to `~/bin`.

## Testing

THe dotfiles setup process is tested using TestKitchen run via GitHub Actions.

You can read more about the setup of the testing process here: [Testing dotfiles with Test Kitchen and InSpec](https://www.jamesridgway.co.uk/testing-dotfiles-with-test-kitchen-and-inspec/)