macOS Shell Dotfiles

Table of contents

• macOS Shell Dotfiles
  • Table of contents
  • About Dotfiles
    • Getting Started
    • Installation
      • Install from CDN
      • Install from GitHub
      • Install from NPM
      • Install the npm command line interface
        • Check installation
      • Install Dotfiles via Yarn
  • In this repository
    • Git dotfiles
    • Bash Shell dotfiles
    • Z Shell dotfiles
    • Homebrew dotfiles
  • Requirements
  • Contributing
  • Code of Conduct
  • Our Values
  • History
  • Acknowledgements
  • License

About Dotfiles

Simply designed to fit your shell life.

The Dotfiles resources aggregate a collection of standalone 'dotfiles' to help you customize your system and related services into one cohesive and consistent approach.

Getting Started

This repository contains the source code for multiple macOS Dotfiles and Shells:

• Git dotfiles
• Bash Shell dotfiles
• Z Shell dotfiles
• Homebrew dotfiles

Installation

A few options are available:

Install from CDN

A pre-bundled package that contains all dotfiles and components needed to use is available on CDN.

The following table lists alternate CDN locations where Dotfiles is hosted.

Install from GitHub

Clone the main repository to get all source files including build scripts:

https://github.com/sebastienrousseau/dotfiles.git

Download Dotfiles

Install from NPM

To use Dotfiles, you will need the npm JavaScript package manager.

Install the npm command line interface

npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer.

To install Node.js and the npm command line interface using either a Node version manager or a Node installer.

Check installation

To check if you have Node.js installed, run this command in your terminal:

node --version

To confirm that you have npm installed you can run this command in your terminal:

npm --version

Install Dotfiles via Yarn

To install Dotfiles, you can use the npm JavaScript package manager as follows:

npm i @sebastienrousseau/dotfiles

In this repository

Within the release you'll find the following files and folders:

.
├── .curlrc
├── .eslintrc
├── .gitignore
├── .jshintrc
├── .travis.yml
├── .wgetrc
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dotfiles.png
├── ISSUE_TEMPLATE.md
├── Icon
├── LICENSE
├── README.md
├── bash
│   ├── .bash_aliases
│   ├── .bash_exit
│   ├── .bash_functions
│   ├── .bash_load_completion
│   ├── .bash_profile
│   └── .bashrc
├── homebrew
│   ├── brew-cask.sh
│   ├── brew-package.sh
│   ├── brew-tap.sh
│   └── install.sh
├── zsh
│   ├── configurations
│   ├── functions
├── installers
└── package.json

Git dotfiles

git
├── config
│   └── git
│       └── template
│           └── HEAD
├── gitattributes
├── gitconfig
├── gitignore
└── gitmessage

3 directories, 5 files

Bash Shell dotfiles

Z Shell dotfiles

Homebrew dotfiles

Requirements

Set zsh as your login shell:

chsh -s $(which zsh)

Contributing

Please read carefully through our Contributing Guidelines for further details on the process for submitting pull requests to us.

Code of Conduct

We are committed to preserving and fostering a diverse, welcoming community. Please read our Code of Conduct.

Our Values

1. We believe perfection must consider everything.
2. We take our passion beyond Code into our daily practices.
3. We are just obsessed about creating and delivering exceptional solutions.

History

• See Dotfiles Release list.

Acknowledgements

Dotfiles is beautifully crafted by these people and a bunch of awesome contributors

Sebastien Rousseau	Graham Colgate

License

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