summaryrefslogtreecommitdiffstats
path: root/src/install/setup.md
blob: 043d9cfefdd5f0b018f42b772e7d920e0362e457 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Setup

Create base directories. I typically treat these as an pseudo-extension of the
[XDG user directory spec](https://wiki.archlinux.org/title/XDG_user_directories).

| Name                    | Usage                                 | Path        |
| ----------------------- | ------------------------------------- | ----------- |
| `XDG_SOURCE_DIR`        | Source code repositories              | `$HOME/src` |
| `XDG_PACKAGES_DIR`      | PKGBUILDs and PKGBUILD related things | `$HOME/pkg` |
| `XDG_CONTAINER_DIR`     | Containerization files                | `$HOME/dkr` |
| `XDG_DOCUMENTATION_DIR` | Documentation related projects        | `$HOME/doc` |

<!-- TODO: possibly impl this with XDG user directories -->

```console
mkdir -p ~/src ~/pkg ~/dkr ~/doc
```

Clone and install my dotfiles.

```console
git clone https://git.sr.ht/~tobyvin/.dotfiles ~/.dotfiles
cd ~/.dotfiles
./install.sh
```