Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Falkor/dotfiles
Personal configuration files for bash, zsh, git, vim, screen etc.
https://github.com/Falkor/dotfiles
Last synced: 9 days ago
JSON representation
Personal configuration files for bash, zsh, git, vim, screen etc.
- Host: GitHub
- URL: https://github.com/Falkor/dotfiles
- Owner: Falkor
- License: other
- Created: 2010-10-03T18:45:40.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2023-12-28T10:31:24.000Z (12 months ago)
- Last Synced: 2024-08-13T07:15:49.043Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 3.96 MB
- Stars: 224
- Watchers: 7
- Forks: 61
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - Falkor/dotfiles - Personal configuration files for bash, zsh, git, vim, screen etc. (Shell)
README
-*- mode: markdown; mode: visual-line; fill-column: 80 -*-
[](http://www.gnu.org/licenses/gpl-3.0.html)  [](https://travis-ci.org/Falkor/dotfiles) [](https://github.com/Falkor/dotfiles) [](https://github.com/Falkor/dotfiles/issues)  [](https://readthedocs.org/projects/falkor-dotfiles/?badge=latest)
Time-stamp:
______ _ _ _ _____ _ __ _ _
| ____| | | | ( ) | __ \ | | / _(_) |
| |__ __ _| | | _____ _ __/ ___ | | | | ___ | |_| |_ _| | ___ ___
| __/ _` | | |/ / _ \| '__|/ __| | | | |/ _ \| __| _| | |/ _ \ __|
| | | (_| | | < (_) | | \__ \ | |__| | (_) | |_| | | | | __\__ \
|_| \__,_|_|_|\_\___/|_| |___/ |_____/ \___/ \__|_| |_|_|\___|___/
Copyright (c) 2011-2016 Sebastien Varrette aka Falkor
# Sebastien Varrette aka Falkor's dotfiles
These are my configuration files for `bash`, `zsh`, `git`, `vim` etc. so as to set up a system the way I like it.
For instance, here is a screenshot of my terminal illustrating its behaviour on classical contexts commonly met on a daily usage of interactions with git repositories etc.
__Warning:__ Use these dotfiles at your own risk!
In the sequel, when providing a command, `$>` denotes a prompt and is not part of the commands.
## Pre-requisites
You should install the following elements to use the full functionality of
these config files:
* bash
* bash-completions
* zsh
* zsh-completions
* screen
* git
* subversion
* vim
* screen
On __Mac OS__, assuming you have installed [HomeBrew](http://brew.sh/) (you really should), you can use `brew/Brewfile.minimal` to install these dependencies as follows:
~~~bash
# Install brew bundle -- see https://github.com/Homebrew/homebrew-bundle
$> brew tap Homebrew/bundle
# Collect the Brewfile
$> curl -o /tmp/Brewfile https://raw.githubusercontent.com/Falkor/dotfiles/master/brew/Brewfile.minimal
# Install Falkor's dotfile dependencies
$> brew bundle --file=/tmp/Brewfile -v
~~~
On __Linux__:
~~~bash
# Debian / Ubuntu
$> sudo apt-get install git git-flow bash-completion screen curl subversion zsh fonts-font-awesome
~~~
## Falkor's dotfiles Installation
### All-in-one git-free install
Using `curl` (adapt the `--all` option to whatever you prefer -- see below table):
``` bash
$> curl -fsSL https://raw.githubusercontent.com/Falkor/dotfiles/master/install.sh | bash -s -- --all
```
### Using Git and the embedded Makefile
This repository is hosted on [Github](https://github.com/Falkor/dotfiles). You can clone the repository wherever you want.
Personally, I like to keep it in `~/git/github.com/Falkor/dotfiles`, with `~/.dotfiles.falkor.d` as a symlink. This behaviour will be reflected in the `install.sh` script _i.e._ if it is invoked from a directory that differs from `~/.dotfiles.falkor.d`, a symlink will be created toward the place where your cloned this repository.
Otherwise, to clone this repository directly into `~/.dotfiles.falkor.d/`, proceed as follows
$> git clone https://github.com/Falkor/dotfiles.git ~/.dotfiles.falkor.d
**`/!\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running:
$> cd ~/.dotfiles.falkor.d
$> make setup
This will initiate the [Git submodules of this repository](.gitmodules) and setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository.
Now to install all my dotfiles, run:
~~~bash
$> make install
~~~
### Using Git and the embedded `install.sh` script
The above `make install` command actually runs (see `.Makefile.after`):
~~~bash
$> ./install.sh --all # Equivalent of 'make install'
~~~
Note that __by default__ (_i.e._ without option), the `install.sh` script does nothing __except__ cloning the Falkor/dotfiles directory if it does not yet exists (in `~/.dotfiles.falkor.d` by default).
* if you __do not want to install everything__ but only a subpart, kindly refer to the below table to find the proper command-line argument to use. Ex:
```bash
$> ./install.sh --zsh --vim --git
```
* if you want to install everything in a row, use as suggested above the `--all` option
## Updating / Upgrading
Upgrading is normally as simple as:
$> make -C ~/.config/dotfiles.falkor.d update
OR, if you prefer a more atomic approach:
$> cd ~/.config/dotfiles.falkor.d
$> make update
Note that if you wish to __upgrade__ the [Git submodules](.gitmodules) to the latest version, you should run:
$> make upgrade
## Uninstalling / Removing Falkor's dotfile
You can use `install.sh --delete` to remove Falkor's dotfiles.
__`/!\ IMPORTANT`__: pay attention to use the options matching you installation package.
* if you install __all__ dotfiles, run:
```bash
$> ./install.sh --delete --all # OR make uninstall
```
* if you install __only__ a subpart of the dotfiles, adapt the command line option. Ex:
```bash
$> ./install.sh --delete --zsh --vim --git
```
## What's included and how to customize?
| Tools | Type | Installation | Documentation |
|--------------------------------------------------------------------------------|-----------------------|-------------------------|----------------------------------------------|
| [Bourne-Again shell (bash)](http://tiswww.case.edu/php/chet/bash/bashtop.html) | shell | `./install.sh --bash` | [`bash/README.md`](bash/README.md) |
| [zsh](http://www.zsh.org/) / [Oh-my-zsh](http://ohmyz.sh/) | shell | `./install.sh --zsh` | [`oh-my-zsh/README.md`](oh-my-zsh/README.md) |
| [VI iMproved (vim)](http://www.vim.org/) | editor | `./install.sh --vim` | [`vim/README.md`](vim/README.md) |
| [GNU Emacs](https://www.gnu.org/software/emacs/) | editor | `./install.sh --emacs` | `emacs/README.md` |
| [Git `--fast-version-control`](https://git-scm.com/) | VCS | `./install.sh --git` | [`git/README.md`](git/README.md) |
| [GNU screen](https://www.gnu.org/software/screen/) | terminal multiplexers | `./install.sh --screen` | [`screen/README.md`](screen/README.md) |
| | | | |
As mentioned above, if you want to install all dotfiles in one shot, just use
$> ./install.sh --all # OR 'make install'
## Issues / Feature request
You can submit bug / issues / feature request using the [`Falkor/dotfiles` Project Tracker](https://github.com/Falkor/dotfiles/issues)
## Developments / Contributing to the code
If you want to contribute to the code, you shall be aware of the way this repository is organized and developed.
These elements are detailed on `docs/contributing/`
## Licence
This project is released under the terms of the [GPL-3.0](LICENCE) licence.
[](http://www.gnu.org/licenses/gpl-3.0.html)
## Resources
You can find of course many other resources in terms dotfiles repositories.
I suggest you to take a look at the following places I inspired:
* [Your unofficial guide to dotfiles on GitHub](https://dotfiles.github.io/)
* My friend [H.Cartiaux's dotfiles](https://github.com/hcartiaux/dotfiles)
* [Holman's does dotfiles](https://github.com/holman/dotfiles), for his idea of bundling the [homebrew](http://brew.sh) configuration
* [Mathias’s dotfiles](https://github.com/mathiasbynens/dotfiles), for featuring `~/.osx` _i.e._ sensible hacker defaults for OS X;
* [Awesome dotfiles](https://github.com/webpro/awesome-dotfiles), a curated list of dotfiles resources. Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.
* [Carlo's dotfiles](https://github.com/caarlos0/dotfiles)