https://github.com/abyss/dotfiles

My personal dotfiles
https://github.com/abyss/dotfiles

dotfiles

Last synced: about 1 month ago
JSON representation

My personal dotfiles

• Host: GitHub
• URL: https://github.com/abyss/dotfiles
• Owner: abyss
• License: mit
• Created: 2019-09-04T21:09:29.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T17:42:12.000Z (4 months ago)
• Last Synced: 2024-09-11T01:15:41.108Z (4 months ago)
• Topics: dotfiles
• Language: Shell
• Size: 81.1 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![License: MIT](https://img.shields.io/github/license/abyss/dotfiles?style=for-the-badge)

![Uses git](https://img.shields.io/badge/uses-git-blue?style=for-the-badge)

![Works on my machine](https://img.shields.io/badge/works%20on-my%20machine-red?style=for-the-badge)

# Abyss' Dotfiles

My personal dotfiles repository. Feel free to modify for your own use.

## If you want to use this, and you are not me

If you intend to use this as a template for your dotfiles, and you are not me, I strongly suggest you do the following things to personalize it.

1) :star: [this repo](https://github.com/abyss/dotfiles) on GitHub!

2) **Remove or replace the authorized_keys with your own authorized_keys.** *These aren't installed by the script, they only exist for manual copying.*

3) *(Optional)* Inside `install.sh`, change the git config options.

4) *(Optional)* Change any other files to your liking.

## Setup

1) `git clone https://github.com/abyss/dotfiles.git`

2) *(Optional)* On Windows, see [Getting symlinks to work on Windows](#getting-symlinks-to-work-on-windows).

3) `bash ./dotfiles/install.sh`

> **Warning:** this will remove your current `~/.bashrc`, `~/.vim`, `~/.bash_aliases`, `~/.tflint.hcl`, `~/.tflint.module.hcl`, and `~/.gitignore`.

4) *(Optional)* On MacOS, `brew bundle` will install the Brewfile contents.

## Updating

Any existing files will be updated by a `git pull`.

Creation of new files, changes to git config options, and install process may be updated by executing `install.sh` again.

## Getting symlinks to work on Windows

If you are running the install on Windows, the symlinks will not work out of the box. To fix this, you need to do two things:

1) Run Git Bash as Administrator

2) Set the following environment variable first: `export MSYS=winsymlinks:nativestrict`

## Additional Notes

1) The `~/bin` directory will be created if it does not already exist.

2) `.bash_aliases` and `.bashrc` will be symlinked into your home directory.

3) `.vim` will be symlinked into your home directory.

4) `.tflint.hcl` will be symlinked into your home directory.

5) `linked.gitignore` will be symlinked as `~/.gitignore` into your home directory.

6) `~/.system_aliases` will be created if it does not already exist. You can put system-specific aliases here that you do not want to be tracked by git.

7) git config global options are configured inside of `install.sh`, rather than by file.

8) `install.sh` should be able to be run multiple times with no bad side effects.

9) The `.ssh` directory includes an authorized_keys, but it is not managed automatically.