Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d2s/dot
:cloud: 2016–2023→ — Configuration files for Linux & macOS environments
https://github.com/d2s/dot
dotfiles zsh
Last synced: 3 months ago
JSON representation
:cloud: 2016–2023→ — Configuration files for Linux & macOS environments
- Host: GitHub
- URL: https://github.com/d2s/dot
- Owner: d2s
- Created: 2016-08-10T17:27:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T16:44:03.000Z (8 months ago)
- Last Synced: 2024-04-24T16:43:03.796Z (7 months ago)
- Topics: dotfiles, zsh
- Language: Shell
- Homepage: https://github.com/d2s/dot
- Size: 311 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dot
Configuration files for Linux & macOS environments
---
## Setup
```sh
# If you don't already have Git installed:
# sudo apt install git
# Clone the repository via HTTPS to a hidden subdirectory
git clone https://github.com/d2s/dot.git ~/.dotfiles
# Clone the repository via SSH to a hidden subdirectory
# (if you have added SSH public key to GitHub's user settings)
#
# git clone [email protected]:d2s/dot.git ~/.dotfiles
# Install Zinit
mkdir ~/.dotfiles/zsh/zinit
git clone https://github.com/zdharma/zinit.git ~/.dotfiles/zsh/zinit/bin
# Link Zsh configuration files
ln -sf ~/.dotfiles/zsh/zshrc.symlink ~/.zshrc
# Link Git configuration files
ln -sf ~/.dotfiles/git/gitconfig ~/.gitconfig
ln -sf ~/.dotfiles/git/gitignore_global ~/.gitignore
# Install related tools...
# If on a Debian-based Linux system:
~/.dotfiles/scripts/install-apt-packages.sh
# If on a openSUSE-based Linux system:
~/.dotfiles/scripts/install-suse.sh
# Change default terminal shell to Zsh
chsh -s $(which zsh)
# After you have installed Node.js
# Install CLI tools from npm
~/.dotfiles/scripts/install-npm-packages.sh
# Get the submodule dependencies (not be needed anymore)
# NOTE: colors palette
#
# git submodule init
# git submodule update
```
---
## Git configuration
Create a `~/.gitconfig.local` file for the local overrides.
It allows you to adjust Git configs for system-specific needs
while keeping the shared settings in the version control.
```sh
touch ~/.gitconfig.local
code ~/.gitconfig.local
```
### Example local Git config file
```txt
[user]
name = Firstname Lastname
email = [email protected]
# signingkey = 0000000000000000
[github]
user = your_github_username
```
### Sign Git commits with a GPG key
GPG key is required for creating new Git commits.
Update the `signingkey` part of `~/.gitconfig.local` file to match your local system.
More details about how to sign Git commits with a GPG key is available from the following article:
- [Signing commits - GitHub Help](https://help.github.com/articles/signing-commits-using-gpg/)
---
## Dependencies to install manually
- Node.js
- [Installing Node.js with nvm](https://gist.github.com/d2s/372b5943bce17b964a79)
- `hub`
- [Releases · github/hub · GitHub](https://github.com/github/hub/releases)
### Create common directories
```sh
mkdir ~/bin
mkdir ~/Documents/git
```
---
## Migrating from Zplugin to Zinit
If you have a previous installation of Zplugin,
it should be migrated to use [Zinit](https://github.com/zdharma/zinit).
### Clone the Zinit repository to a subdirectory
```sh
cd ~/.dotfiles/zsh
mkdir zinit
git clone https://github.com/zdharma/zinit.git zinit/bin
```
### Update `.gitignore` file to avoid committing unneeded files
```conf
# Zinit ignored directories
# - https://github.com/zdharma/zinit
zsh/zinit/plugins
zsh/zinit/root_completions
zsh/zinit/snippets/plugins
```
### Open a new terminal to install updated dependencies
After a moment of waiting time, the Zinit environment should be usable again.
### Remove old Zplugin directory
After making sure that there aren't any files you need from it,
remove the old Zplugin directory.
NOTE: *Be careful with the `rm` remove command!*
```sh
cd ~/.dotfiles/zsh
rm -rdf zplugin
```
### Do the same steps on other machines
Because the Zinit installation is outside of the `dot` Git repository
you need to repeat the installation steps to migrate other machines to the new config.
You will see error message before running rest of the steps
if you open a new terminal without first doing the migration.
```sh
cd ~/.dotfiles/zsh
mkdir zinit
git clone https://github.com/zdharma/zinit.git zinit/bin
cd ~/.dotfiles/zsh
rm -rdf zplugin
```
---
## More details
### Zsh extensions
- [Zinit](https://github.com/zdharma/zinit)
- "Flexible Zsh plugin manager with clean fpath, reports, completion management, Turbo, annexes, services, packages."
## Optional packages to consider
### Fonts
- [tonsky/FiraCode](https://github.com/tonsky/FiraCode) _(Monospaced font with programming ligatures)_
- [Install instructions for the typeface](https://github.com/tonsky/FiraCode/wiki)
- [Font Awesome](http://fontawesome.io/) _(icon font and CSS toolkit)_
- Download zip file
- Uncompress zip file.
- Open `fonts/FontAwesome.otf` file to add it to the operating system.