How joeky888/dotfile works
Project type and purpose
• This is a “dotfiles” repository: a collection of shell/IDE/editor/OS configuration files and platform-specific documentation, bundled with an install script (install.sh).
• Purpose is to bootstrap a user’s environment: clone the repo, run the installer, and populate ~ with your preferred configs (bash, zsh, fish, tmux, vim, VSCode, etc.) and reference OS-specific guides.
File structure
• Top-level “dotfile” artifacts: .bashrc, .zshrc (via ohmyzsh), starship.toml, tmux.conf, vimrc, VSCode settings, etc.
• Platform-specific directories:
• Android/ – MD guides for Android tooling and shells
• BSD/, Linux/, MacOS/, Windows/ – OS-specific notes and scripts
• Utility directories:
• Dockerfile/ – container base images for testing or building environments
• Programming/, Software/, Web/, Misc/ – documentation, cheatsheets, tutorials
• Framework integrations: ohmyzsh/, zsh-autosuggestions/, powerlevel10k/, and fish config.
README
• Very simple: fetch and run install.sh (or pipe to zsh for MacOS/FreeBSD), or individually grab .bashrc or Fish config.