tuldok (dot) - dotfiles

tuldok is dot in English. This repository is intended to store and document the changes I do to customize my GNU/Linux experience. It is ever changing and will depend on the whims of tako.

Requirements

To start using the dotfiles, install these: fastfetch, kitty, neovim, starship, zsh, MangoHud, BetterDiscord, zellij and btop.

Neovim Requirements

telescope.nvim plugin uses some binaries that it needs in order to run properly. The binaries are: gcc, make, fd, ripgrep.

nvim-treesitter plugin requires: Node.js.

null-ls.nvim plugin requirements depends on the configured BUILTINS.

NOTE: You can always check the dependencies needed by the plugins by using :checkhealth in Vim

NOTE: clipboard seems to work if xsel/xclip is installed, if on Wayland use: wl-clipboard

ZSH Requirements

In order to use pomodoro alias, install timer

Also, if in a WSL environment, it is required to install win32yank and wsl-notify-send. To install both, just do:

$ curl -sLo/tmp/win32yank.zip https://github.com/equalsraf/win32yank/releases/download/v0.1.1/win32yank-x64.zip
$ unzip -p /tmp/win32yank.zip win32yank.exe > /tmp/win32yank.exe
$ chmod +x /tmp/win32yank.exe
$ sudo mv /tmp/win32yank.exe /usr/local/bin/

$ curl -sLo/tmp/wsl-notify-send_windows_amd64.zip https://github.com/stuartleeks/wsl-notify-send/releases/download/v0.1.871612270/wsl-notify-send_windows_amd64.zip
$ unzip -p /tmp/wsl-notify-send_windows_amd64.zip wsl-notify-send.exe > /tmp/wsl-notify-send.exe
$ chmod +x /tmp/wsl-notify-send.exe
$ sudo mv /tmp/wsl-notify-send.exe /usr/local/bin/

Nerd Fonts

After installing the requirements, configure font family for the terminal emulator [kitty] by downloading a font from Nerd Fonts (preferably, Ubuntu Mono since kitty is configured to do so).

If font is not Ubuntu Mono, you can configure the font family used by kitty by editing font.conf and changing to your desired font by consulting kitty +list-fonts

ZSH Environment

ZSH environment variables are configured to be stored inside the XDG compliant config directory, which in this case is located at $HOME/.config/zsh/ or $XDG_CONFIG_HOME.

In order for your system to store and read from the .zshenv located at $XDG_CONFIG_HOME, you need to first edit the main zshenv that the system reads which is located at /etc/zsh/zshenv.

$ sudoedit /etc/zsh/zshenv

-- OR --

$ EDITOR="your choice text editor" sudoedit /etc/zsh/zshenv

And add this line:

export ZDOTDIR="$HOME"/.config/zsh

This defaults your zsh config directory at $HOME/.config/zsh

Installation

The installation is rather primitive and makes use of GNU Stow. Once installed, you can then run it under terminal sh install.sh

Additional Reads

In each dot directory, there is a README file for additional information of where did the inspiration or idea of this whole tuldok repository came from.

To ease the access of each of the README, consult the hyperlink below:

• fastfetch README
• kitty README
• neovim README
• starship README
• zsh README