https://github.com/gocom/dotfiles
Personal dotfiles
https://github.com/gocom/dotfiles
bash-profile dotfiles
Last synced: about 1 month ago
JSON representation
Personal dotfiles
- Host: GitHub
- URL: https://github.com/gocom/dotfiles
- Owner: gocom
- License: mit
- Created: 2018-12-03T17:05:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T16:07:02.000Z (10 months ago)
- Last Synced: 2024-06-25T17:06:15.590Z (10 months ago)
- Topics: bash-profile, dotfiles
- Language: Shell
- Size: 491 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
.dotfiles
=====
Personal [Bash](https://www.gnu.org/software/bash/) shell configuration files
and scripts.
Supported OS
-----
* Ubuntu 22.04 LTS
* Ubuntu 20.04 LTS in WSL2
* Ubuntu 22.04 LTS in WSL2
* macOS 13 on Apple Silicon
Prerequisites
-----
Dotfiles require:
* [Bash](https://www.gnu.org/software/bash/) >= 4.3
* GNU awk
* [GNU Coreutils](https://www.gnu.org/software/coreutils/coreutils.html)
* perl
Building and installing requires:
* GNU make
* Docker and docker-compose, or [Docker Desktop](https://www.docker.com/products/docker-desktop/)
### On macOS
On macOS, you may want:
* Xcode
* [Homebrew](https://brew.sh/) package manager
You can then use Homebrew to install [bash](https://formulae.brew.sh/formula/bash)
and [coreutils](https://formulae.brew.sh/formula/coreutils).
Install
-----
It is expected that dotfiles are accessible through `~/.dotfiles`, either by
a link or otherwise. Clone the repository to that location and run the
installer, which creates symbolic links to your home directory:
```shell
$ git clone https://github.com/gocom/dotfiles.git ~/.dotfiles && cd ~/.dotfiles
$ make install
```
The above requires Docker and docker-compose. Docker is used for building man
pages and other assets, without placing hard requirements on the host
system.
If you do not require man pages or other assets, and just want to symlink
dotfiles to your home directory, you can run:
```shell
$ make link
```
The above avoids Docker requirement and all actions are
performed on the host system.
Customizing Bash configuration
-----
Local Bash configuration can be customized from `~/.bash_login`,
`~/.bash_aliases` and `~/.bash_config` files. If one of these exists, it is
included in the login shell bashrc and never overwritten by the installer.
```
echo 'export EDITOR=/usr/local/bin/atom' >> ~/.bash_config
```
Configuring git
-----
Local git config can be provided with `~/.gitconfig_local`.
```
git config --file ~/.gitconfig_local user.email [email protected]
git config --file ~/.gitconfig_local user.name "Foo Bar"
```