https://github.com/fredlackey/dotfiles-removed-20210212
https://github.com/fredlackey/dotfiles-removed-20210212
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fredlackey/dotfiles-removed-20210212
- Owner: FredLackey
- License: mit
- Created: 2020-03-16T19:35:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-09T23:58:19.000Z (about 5 years ago)
- Last Synced: 2025-01-24T10:30:47.991Z (4 months ago)
- Language: Shell
- Size: 349 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[Fred][repo]’s dotfiles
==========================
[![Build Status][ci badge]][ci link]
These are the base dotfiles that I start with when I set up a new
environment. For more specific local needs I use the `*.local` files
described in the [`Local Settings`](#local-settings) section.
Table of Contents
-----------------
* [🔧 Setup](#setup)
* [💄 Customize](#customize)
* [🔀 Forks](#forks)
* [🌐 Local Settings](#local-settings)
* [🐚 `~/.bash.local`](#bashlocal)
* [🔁 `~/.gitconfig.local`](#gitconfiglocal)
* [⌨️ `~/.vimrc.local`](#vimrclocal)
* [↕️ Update](#update)
* [📸 Screenshots](#screenshots)
* [🔁 `Git`](#git)
* [⌨️ `tmux` & `Vim`](#tmux--vim)
* [📄 License](#license)
Setup
-----
To set up the `dotfiles` run the appropriate snippet in the terminal:
(⚠️ **DO NOT** run the `setup` snippet if you do not fully understand
[what it does][setup]. Seriously, **DON'T**!)
| OS | Snippet |
|:---|:---|
| `macOS` | `bash -c "$(curl -LsS https://raw.github.com/FredLackey/dotfiles/master/src/os/setup.sh)"` |
| `Ubuntu` | `bash -c "$(wget -qO - https://raw.github.com/FredLackey/dotfiles/master/src/os/setup.sh)"` |
That's it! ✨
The setup process will:
* Download the dotfiles on your computer
(by default it will suggest `~/Setup/dotfiles`).
* Create some additional [directories][dirs].
* [Symlink][symlink] the [`git`][git], [`shell`][shell],
and [`vim`][vim] files.
* Install applications / command-line tools for
[`macOS`][install macos] / [`Ubuntu`][install ubuntu].
* Set custom [`macOS`][preferences macos] /
[`Ubuntu`][preferences ubuntu] preferences.
* Install [`vim` plugins][vim plugins].
Setup process in action:
| ![Setup process on macOS][setup macos] | ![Setup process on Ubuntu][setup ubuntu] |
|:---:|:---:|
| `macOS` | `Ubuntu` |
Customize
---------
### Local Settings
The `dotfiles` can be easily extended to suit additional local
requirements by using the following files:
#### `~/.bash.local`
The `~/.bash.local` file will be automatically sourced after all
the other [`bash` related files][shell], thus, allowing its content
to add to or overwrite the existing aliases, settings, `PATH`, etc.
Here is a very simple example of a `~/.bash.local` file:
```bash
#!/bin/bash
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Set local aliases.
alias g="git"
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Set PATH additions.
PATH="$PATH:$HOME/projects/dotfiles/src/bin"
export PATH
```
#### `~/.gitconfig.local`
The `~/.gitconfig.local` file will be automatically included after
the configurations from `~/.gitconfig`, thus, allowing its content
to overwrite or add to the existing `Git` configurations.
__Note:__ Use `~/.gitconfig.local` to store sensitive information
such as the `Git` user credentials, e.g.:
```bash
[commit]
# Sign commits using GPG.
# https://help.github.com/articles/signing-commits-using-gpg/
gpgsign = true
[user]
name = Fred Lackey
email = [email protected]
signingkey = XXXXXXXX
```
#### `~/.vimrc.local`
The `~/.vimrc.local` file will be automatically sourced after
`~/.vimrc`, thus, allowing its content to add or overwrite the
settings from `~/.vimrc`.
### Forks
If you decide to [fork] this project, do not forget to substitute
my username with your own in the [`setup` snippets](#setup) and
[in the `setup` script][setup script].
Update
------
To update the dotfiles you can either run the [`setup` script][setup]
or, if you want to update one particular part, run the appropriate
[`os` script](src/os).
Screenshots
-----------
### Git
Output for `Git status`:
| ![Output for Git status on macOS][git output macos] | ![Output for Git status on Ubuntu][git output ubuntu] |
|:---:|:---:|
| `macOS` | `Ubuntu` |
Output for `Git log`:
| ![Output for Git log on macOS][git log macos] | ![Output for Git log on Ubuntu][git log ubuntu] |
|:---:|:---:|
| `macOS` | `Ubuntu` |
### tmux & Vim
| ![tmux and Vim on macOS][vim macos] | ![tmux and Vim on Ubuntu][vim ubuntu] |
|:---:|:---:|
| `macOS` | `Ubuntu` |
License
-------
The code is available under the [MIT license][license].
[ci badge]: https://github.com/FredLackey/dotfiles/workflows/test/badge.svg
[ci link]: https://github.com/FredLackey/dotfiles/actions
[dirs]: src/os/create_directories.sh
[fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
[git log macos]: https://cloud.githubusercontent.com/assets/1223565/10560966/e4ec08a6-7523-11e5-8941-4e12f6550a63.png
[git log ubuntu]: https://cloud.githubusercontent.com/assets/1223565/10560955/4b5e1300-7523-11e5-9e96-95ea67de9474.png
[git output macos]: https://cloud.githubusercontent.com/assets/1223565/10561038/f9f11a28-7525-11e5-8e1d-a304ad3557f9.png
[git output ubuntu]: https://cloud.githubusercontent.com/assets/1223565/8397636/3708d218-1ddb-11e5-9d40-21c6871271b9.png
[git]: src/git
[install macos]: src/os/install/macos
[install ubuntu]: src/os/install/ubuntu
[license]: LICENSE.txt
[preferences macos]: src/os/preferences/macos
[preferences ubuntu]: src/os/preferences/ubuntu
[repo]: https://github.com/FredLackey
[setup macos]: https://cloud.githubusercontent.com/assets/1223565/19314446/cd89a592-90a2-11e6-948d-9d75247088ba.gif
[setup script]: https://github.com/FredLackey/dotfiles/blob/2f53485df6be75d207d4c5c03c265730b416555a/src/os/setup.sh#L3
[setup ubuntu]: https://cloud.githubusercontent.com/assets/1223565/19048636/e23e347a-89af-11e6-853c-98616b75b6ae.gif
[setup]: src/os/setup.sh
[shell]: src/shell
[symlink]: src/os/create_symbolic_links.sh
[vim macos]: https://cloud.githubusercontent.com/assets/1223565/10561007/498e1212-7525-11e5-8252-81503b3d6184.png
[vim plugins]: src/vim/vim/pack/minpac/start
[vim ubuntu]: https://cloud.githubusercontent.com/assets/1223565/10560956/557ca2de-7523-11e5-9000-fc1e189a95f5.png
[vim]: src/vim