Documentation

Everything you need to know about setting up and customizing your development environment.

Introduction

These dotfiles are a curated collection of configuration files and installation scripts designed to quickly set up a productive development environment. Whether you are setting up a new machine or want to standardize your workflow across multiple computers, these dotfiles provide a solid foundation.

The configuration focuses on modern development tools, sensible defaults, and ease of use. Everything is organized in a modular way, making it easy to pick and choose which components you want to install.

Installation

Getting started is simple. Run the following command in your terminal:

curl -fsSL https://mms-dotfiles.netlify.app/install | bash

This command downloads and executes the installation script, which will guide you through the setup process. The script automatically detects your operating system and installs the appropriate packages.

Alternative Installation

If you prefer to review the script before running it:

# Download the script
curl -fsSL https://mms-dotfiles.netlify.app/install -o install.sh

# Review the script
nano install.sh

# Make it executable and run
chmod +x install.sh
./install.sh

Requirements

Before running the installation script, ensure your system meets the following requirements:

  • Operating System: Ubuntu 20.04+ / Debian 10+
  • Internet Connection: Required for downloading packages and tools
  • Administrator Access: Some components require sudo privileges
  • Git: Required for cloning repositories and managing dotfiles

What Gets Installed

The installation script sets up the following components:

Shell Environment

  • Zsh - Modern shell with powerful features
  • Oh My Zsh - Framework for managing Zsh configuration
  • Custom aliases - Shortcuts for common commands

Development Tools

  • Git - Version control with custom configuration
  • Docker - Containerization platform
  • Node.js - JavaScript runtime via nvm
  • Python - Python 3 with pip and virtualenv

Applications

  • Neovim - Modern Vim-based editor
  • TMUX - Terminal multiplexer

Configuration

All configuration files are stored in the dotfiles directory. Key files include:

  • .zshrc - Zsh shell configuration
  • .gitconfig - Git settings and aliases
  • .vimrc or init.vim - Vim/Neovim configuration
  • .tmux.conf - TMUX settings

To update your configuration, edit the files in the dotfiles directory and run the install script again to apply changes.

Customization

You can customize the installation by creating a custom configuration file. This allows you to:

  • Choose which tools to install
  • Specify custom installation paths
  • Add your own configuration files
  • Disable specific components

Adding Custom Aliases

Create a file at custom/aliases.zsh with your custom aliases:

# Custom aliases
alias ll='ls -la'
alias ..='cd ..'
alias ...='cd ../..'

Troubleshooting

Installation Fails

If the installation fails, check the following:

  • Ensure you have a stable internet connection
  • Verify you have the required permissions
  • Check that your operating system is supported
  • Review the error message for specific issues

Common Issues

Zsh not default shell: Run chsh -s $(which zsh) and log out, then back in.

Oh My Zsh not loading: Ensure ZSH environment variable is set correctly in your profile.