Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iamnewton/dotfiles

UNIX-based system configuration for software development
https://github.com/iamnewton/dotfiles

bash dotfiles homebrew npm

Last synced: 2 months ago
JSON representation

UNIX-based system configuration for software development

Awesome Lists containing this project

README 

        
# dotfiles(1)



Typically software you buy comes with some sort of installer, why not your dotfiles? After manually setting up my dotfiles and installation for years, I decided to take a page from [some](https://github.com/necolas) [other](https://github.com/mathiasbynens) [people's](https://github.com/cowboy) [books](http://dotfiles.github.io) and set up a script that will configure my machine to setup my bash profile and install a few core packages.  Feel free to [poke around](https://github.com/iamnewton/dotfiles/commits/main) the repository, [fork it](https://github.com/iamnewton/dotfiles/fork) to make it your own, [suggest things](https://github.com/iamnewton/dotfiles/issues?labels=feature+request) for me to include, [log a bug](https://github.com/iamnewton/dotfiles/issues/new), or maybe checkout the [features list](#features) to see what's included.



**N.B.** This project has a [Code of Conduct](./.github/CODE_OF_CONDUCT.md). By interacting with this repository, organization, and/or community you agree to abide by its terms.



## Installation



:warning: This will overwrite existing dotfiles in your `$HOME` directory.



```bash

$ /bin/bash -c "$(curl -#fL https://raw.githubusercontent.com/iamnewton/dotfiles/main/bin/dotfiles)"

```



### Requirements



Ensure that you have the following dependencies installed on your system.  If you're on MacOS then you already have these, but a Linux system may not come with all.



* [curl](http://curl.haxx.se)

* [git](http://git-scm.com)



:exclamation: N.B. If you wish to [fork this project](https://github.com/iamnewton/dotfiles/fork) and maintain your own dotfiles, you **MUST** substitute my username for your own in the above command and the variable (`$USERNAME`) found at the top of the `bin/install.sh` script.



## Features



Besides some [custom bash prompts](#shell-custom-bash-prompt), there are some [<tab> completion libraries](https://github.com/iamnewton/dotfiles/wiki/-tab--Completion) installed as well.



### Custom bash prompt



A custom bash prompt based on the [Seti UI color palette](https://github.com/jesseweed/seti-ui) and influenced by [@necolas](https://github.com/necolas), [@gf3](https://github.com/gf3) and [@cowboy](https://github.com/cowboy) custom prompts. When your current working directory is a Git repository, the `$PROMPT` will display the checked-out branch's name (and failing that, the commit SHA that `HEAD` is pointing to). The state of the working tree is reflected in the following way:



| Symbol | Meaning                          |

| :----: | :------------------------------- |

| +      | Uncommitted changes              |

| !      | Unstaged changes                 |

| ?      | Untracked files                  |

| $      | Stashed files                    |



For best results with iTerm, you should install [the SETI color scheme for iTerm](https://github.com/willmanduffy/seti-iterm). Further details are in the `$(dotfiles --prefix)/conf/bash/prompt` file.



#### Screenshot



![](https://iamnewton.github.io/cdn/images/dotfiles-screenshot-v2.png)



### Local/private Bash configuration



Any private and custom Bash commands and configuration should be placed in a `~/.bash_profile.local` file. This file will not be under version control or committed to a public repository. If `~/.bash_profile.local` exists, it will be sourced for inclusion in `bash_profile`.



Here is an example `~/.bash_profile.local`:



```bash

# Github Issues library token

export GH_TOKEN=""



# Aliases

alias code="cd ~/Code"

```



:exclamation: N.B. Because the `$(dotfiles --prefix)/conf/git/config` file is copied to `$HOME/.gitconfig`, any private git configuration specified in `$HOME/.gitconfig.local` will not be committed to your dotfiles repository.



* * *



## Acknowledgements



Inspiration and code was taken from many sources, including (in lexicographical order):



* [@holman](https://github.com/holman) (Zach Holman) https://github.com/holman/dotfiles

* [@mathiasbynens](https://github.com/mathiasbynens) (Mathias Bynens) https://github.com/mathiasbynens/dotfiles

* [@necolas](https://github.com/necolas) (Nicolas Gallagher) https://github.com/necolas/dotfiles