dotfiles/README.md

# Dotfiles

This repository contains useful (config) files that I use on my machines.


## Initialization

On a freshly set up machine, run:

```bash
curl https://code.webartifex.biz/alexander/dotfiles/-/raw/main/.local/share/dotfiles/setup.sh \
     > ./setup.sh && source ./setup.sh && rm ./setup.sh
```

This gives you a local copy of the latest version of this repository
    (located in `$XDG_DATA_HOME/dotfiles`)
    and initializes all the dotfiles provided here on the system.
Further, `zsh` is set up
    with [`oh-my-zsh`](https://ohmyz.sh/) and [`zplug`](https://github.com/zplug/zplug)
    if it is installed.

**Note**: Log out and in again so that `bash` and `zsh` run as *login* shells.
Otherwise, `~/.profile` is probably *not* sourced.

**Important**: Don't forget to back up your current dotfiles!


### Python Development Environments

The develop environments for Python are managed via [`pyenv`](https://github.com/pyenv/pyenv).

To set them up, run:

```bash
create-or-update-python-envs
```

Several Python versions are installed.
Additionally, two `virtualenv`s, called "interactive" and "utils", are also created:
 - "interactive" is the default environment, and
 - "utils" hosts globally available utilities
   (e.g., [youtube-dl](https://github.com/ytdl-org/youtube-dl/)).

Use `pyenv local ...` to specify a particular Python binary for a project.


### Private Dotfiles

After setting up the Python environments (i.e., the "utils"),
    running `mackup restore` symlinks further dotfiles into `~/`.
This only works for this project's maintainer.