Skip to content

markgandolfo/dotfiles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dotfiles

A simple dotfiles manager for my personal configuration files.

Overview

This repository contains my personal configuration files (dotfiles) for various applications and tools. It uses a simple symlink approach to manage configurations and sets up your shell environment.

Installation

1. Clone the repository into your ~/.config directory:

git clone https://github.com/markgandolfo/dotfiles.git ~/.config/dotfiles

2. Before you run

Before running the initialisation script (init.py), ensure you have the following applications installed:

3. Run the initialisation script:

cd ~/.config/dotfiles
./init.py

What does init.sh do?

The initialisation script:

  1. Creates symbolic links from the configuration directories to their appropriate locations in ~/.config/ except for /home_dir/ which symlinks all files to the home directory, and the /script directory which is used for manually run scripts
  2. Adds a source line to your .zshrc file to load additional zsh configurations
  3. Preserves any existing configurations by showing warnings instead of overwriting

Directory Structure

~/.config/dotfiles/
├── init.py            # Initialization script
├── _scripts/          # Not processed by init.py -- helper scripts for installs, etc.
├── _macosx/           # macOS specific stuff, just alacritty applescript for now
├── home/              # Symlinks all files to ~
├── zsh/               # ZSH configuration files
│   ├── mark.zsh       # entry point for ./zshrc to source
│   ├── exports.zsh
│   └── alias.zsh
├── config             # Everything in here will be symlinked to ~/.config
│   ├── alacritty
│   ├── gitui
│   ├── oxker
│   ├── spotify-player
│   └── zellij
└── ...

Adding New Configurations

To add new application configurations:

  1. Create a directory in the repository root with the application name
  2. Add your configuration files to this directory
  3. Run ./init.sh again to create the necessary symlinks

Customisation

Feel free to modify any of the configuration files to suit your preferences. After making changes, configurations will update automatically since they're symlinked.

Updating

To update your dotfiles with the latest changes from the repository:

cd ~/.config/dotfiles
git pull
./init.py

License

MIT

Contact

If you have any questions or suggestions, please feel free to open an issue on the repository.

About

My Dotfiles

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors