README

Este repositório contém dotfiles e configurações pessoais, gerenciados
usando Git e GNU Stow.  O GNU Stow é um gerenciador de links simbólicos
que agrupa pacotes distintos de software e/ou dados localizados em uma
única árvore de diretórios e faz com que pareçam estar instalados no
mesmo lugar.

--- Estrutura do Repositório -------------------------------------------

O repositório é estruturado para imitar os caminhos exatos onde os
arquivos residirão no diretório home, agrupados dentro de seus
respectivos pacotes.

~/dotfiles/
|-- README
|-- deploy.sh
|-- bash/
|   |-- .bash_profile   -> linkado para ~/.bash_profile
|   `-- .bashrc         -> linkado para ~/.bashrc
|-- git/
|   `-- .gitconfig      -> linkado para ~/.gitconfig
|-- irssi/
|   `-- .irssi/
|       `-- config      -> linkado para ~/.irssi/config
|-- vim/
|   `-- .vimrc          -> linkado para ~/.vimrc
`-- x11/
    `-- .xinitrc        -> linkado para ~/.xinitrc

--- Implantação --------------------------------------------------------

Para implantar estes dotfiles em uma instalação limpa do Arch Linux:

1. Clone o repositório em ~/dotfiles:
   $ git clone https://git.sr.ht/~librefos/dotfiles.git ~/dotfiles
   $ cd ~/dotfiles

2. Execute o script interativo de implantação:
   $ ./deploy.sh

O script detectará automaticamente os pacotes disponíveis e solicitará
que você informe os nomes dos pacotes que deseja implantar, separados
por vírgula.  Você também pode automatizar a execução passando os nomes
diretamente como argumento (ex: `./deploy.sh bash,git,vim`).  Para
obter uma lista dos pacotes disponíveis para uso em automação, passe o
parâmetro `--list`.

Se o script detectar arquivos regulares existentes nos locais de
destino (como um ~/.bashrc padrão), ele os renomeará com segurança com
uma extensão .bak antes de criar os links simbólicos.  Se você precisar
fazer ajustes específicos da máquina nestas configurações, prefira
colocá-los em arquivos .local não rastreados pelo Git quando suportado,
ou gerencie as variações diretamente via branches.

--- English Version ----------------------------------------------------

This repository contains personal dotfiles and configurations, managed
using Git and GNU Stow.  GNU Stow is a symlink farm manager which takes
distinct packages of software and/or data located in a single directory
tree, and makes them appear to be installed in the same place.

--- Repository Structure -----------------------------------------------

The repository is structured to mimic the exact paths where the files
will reside in the home directory, scoped within their respective
packages.

~/dotfiles/
|-- README
|-- deploy.sh
|-- bash/
|   |-- .bash_profile   -> symlinked to ~/.bash_profile
|   `-- .bashrc         -> symlinked to ~/.bashrc
|-- git/
|   `-- .gitconfig      -> symlinked to ~/.gitconfig
|-- irssi/
|   `-- .irssi/
|       `-- config      -> symlinked to ~/.irssi/config
|-- vim/
|   `-- .vimrc          -> symlinked to ~/.vimrc
`-- x11/
    `-- .xinitrc        -> symlinked to ~/.xinitrc

--- Deployment ---------------------------------------------------------

To deploy these dotfiles on a fresh Arch Linux installation:

1. Clone the repository into ~/dotfiles:
   $ git clone https://git.sr.ht/~librefos/dotfiles.git ~/dotfiles
   $ cd ~/dotfiles

2. Execute the interactive deployment script:
   $ ./deploy.sh

The script will automatically detect available packages and prompt you
to provide the names of the packages to deploy, separated by commas.
You can also automate execution by passing the names directly as an
argument (e.g., `./deploy.sh bash,git,vim`).  To get a parseable list
of available packages for use in scripts, pass the `--list` flag.

If it detects existing regular files at the target locations (such as a
default ~/.bashrc), it will safely rename them with a .bak extension
before creating the symlinks.  If you need to make machine-specific
adjustments to these configs, prefer putting them in un-tracked .local
files when supported, or manage variations directly via Git branches.