Skip to content
/ dot Public

☁️ 2016–2023→ — Configuration files for Linux & macOS environments

Notifications You must be signed in to change notification settings

d2s/dot

Repository files navigation

dot

Configuration files for Linux & macOS environments


Setup

# If you don't already have Git installed:
# sudo apt install git

# Clone the repository via HTTPS to a hidden subdirectory
git clone https://github.com/d2s/dot.git ~/.dotfiles

# Clone the repository via SSH to a hidden subdirectory
# (if you have added SSH public key to GitHub's user settings)
#
# git clone [email protected]:d2s/dot.git ~/.dotfiles

# Install Zinit
mkdir ~/.dotfiles/zsh/zinit
git clone https://github.com/zdharma/zinit.git ~/.dotfiles/zsh/zinit/bin

# Link Zsh configuration files
ln -sf ~/.dotfiles/zsh/zshrc.symlink ~/.zshrc

# Link Git configuration files
ln -sf ~/.dotfiles/git/gitconfig ~/.gitconfig
ln -sf ~/.dotfiles/git/gitignore_global ~/.gitignore

# Install related tools...
# If on a Debian-based Linux system:
~/.dotfiles/scripts/install-apt-packages.sh

# If on a openSUSE-based Linux system:
~/.dotfiles/scripts/install-suse.sh

# Change default terminal shell to Zsh
chsh -s $(which zsh)

# After you have installed Node.js
# Install CLI tools from npm
~/.dotfiles/scripts/install-npm-packages.sh

# Get the submodule dependencies (not be needed anymore)
#   NOTE: colors palette
#
# git submodule init
# git submodule update

Git configuration

Create a ~/.gitconfig.local file for the local overrides. It allows you to adjust Git configs for system-specific needs while keeping the shared settings in the version control.

touch ~/.gitconfig.local
code ~/.gitconfig.local

Example local Git config file

[user]
  name = Firstname Lastname
  email = [email protected]
  # signingkey = 0000000000000000

[github]
  user = your_github_username

Sign Git commits with a GPG key

GPG key is required for creating new Git commits. Update the signingkey part of ~/.gitconfig.local file to match your local system.

More details about how to sign Git commits with a GPG key is available from the following article:


Dependencies to install manually

Create common directories

mkdir ~/bin
mkdir ~/Documents/git

Migrating from Zplugin to Zinit

If you have a previous installation of Zplugin, it should be migrated to use Zinit.

Clone the Zinit repository to a subdirectory

cd ~/.dotfiles/zsh
mkdir zinit
git clone https://github.com/zdharma/zinit.git zinit/bin

Update .gitignore file to avoid committing unneeded files

# Zinit ignored directories
# - https://github.com/zdharma/zinit
zsh/zinit/plugins
zsh/zinit/root_completions
zsh/zinit/snippets/plugins

Open a new terminal to install updated dependencies

After a moment of waiting time, the Zinit environment should be usable again.

Remove old Zplugin directory

After making sure that there aren't any files you need from it, remove the old Zplugin directory.

NOTE: Be careful with the rm remove command!

cd ~/.dotfiles/zsh
rm -rdf zplugin

Do the same steps on other machines

Because the Zinit installation is outside of the dot Git repository you need to repeat the installation steps to migrate other machines to the new config.

You will see error message before running rest of the steps if you open a new terminal without first doing the migration.

cd ~/.dotfiles/zsh
mkdir zinit
git clone https://github.com/zdharma/zinit.git zinit/bin
cd ~/.dotfiles/zsh
rm -rdf zplugin

More details

Zsh extensions

  • Zinit
    • "Flexible Zsh plugin manager with clean fpath, reports, completion management, Turbo, annexes, services, packages."

Optional packages to consider

Fonts

About

☁️ 2016–2023→ — Configuration files for Linux & macOS environments

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •