My Rice

Overview

Here you can find my configs:

File	Description	Project Page
.bashrc	Bash shell configuration.	Bash shell
.ghci	GHC interactive environment configuration.	GHC
.profile	Initialisation script for shell sessions.	Bash Startup Files
.tmux.conf	TMUX terminal multiplexer configuration.	TMUX
.vimrc	Vim text editor configuration.	Vim or Neovim
.xbashrc	Bash configuration for specific scenarios.	Bash shell
.zshenv	Environment variables for Zsh.	Zsh
.zshrc	Zsh configuration file.	Zsh
.scripts/	Utility scripts for a variety of tasks.	Utility scripts
.config/redshift.conf	Redshift configuration file.	Redshift
.config/nvim/init.vim	Neovim configuration file.	Neovim
.installed	Keeps track of installed applications (not fully up to date).	-

The Scripts Directory

The .scripts directory contains my utility scripts, with a special emphasis on the bootstrap scripts for those who appreciate a quick and efficient setup process.

• bootstrap.sh: Installs all the important programs you may need. I use this whenever I deploy a new machine or vps.

Installation

Clone this repo to your local machine:

git clone https://github.com/WillMatthews/dotfiles.git
cd dotfiles

Symlink the dotfiles you wish to adopt into your home directory. For instance, to use the .vimrc:

ln -s $(pwd)/.vimrc ~/.vimrc

In my use, I just mv everything into my home directory. The .gitignore only includes the files in this repo, so it's easy to manage them. Other files in your home directory will not interfere.

cd dotfiles
mv * ~/
mv .* ~/

Using Scripts

The scripts within the .scripts directory are designed for direct execution. For detailed usage instructions, consult the comments within each script or execute them with -h or --help for help information (if it is present!). Otherwise, each script will tell you what it does in a comment.

I include .scripts in my $PATH, which you can find in .zshrc. If you don't want my .zshrc but still want to include .scripts in your $PATH, do:

export PATH=$HOME/.scripts:$PATH 

Customisation

You’re encouraged to fork this repository and tweak the dotfiles and scripts to your heart's content, tailoring them to fit your own preferences and workflow. Make them your own!

Contributing

Should you have any suggestions for refining these dotfiles or scripts, please do not hesitate to open an issue or submit a pull request. There are bound to be issues in here!

Licence

This project is licensed under the MIT License - see the LICENSE file for details.

The MIT License is a permissive free software license originating at the Massachusetts Institute of Technology (MIT). It permits reuse within proprietary software provided that all copies of the licensed software include a copy of the MIT License terms and notices. This license does not protect against patent claims, and it does not include express provisions for the distribution of software modifications.

Other useful apps I use:

• entr
• todolist