README.md (4021B) - raw

      1 # Dotfiles
      2 
      3 This directory hosts some of my dotfiles.
      4 
      5 ## Palette
      6 
      7 The colors used on most places are based on the vim onedark theme. They are the
      8 following:
      9 
     10 | Color   | Color number |
     11 | :------ | :----------- |
     12 | black   | #282c34      |
     13 | red     | #e06c75      |
     14 | green   | #98c379      |
     15 | yellow  | #e5c07b      |
     16 | blue    | #61afef      |
     17 | magenta | #c678dd      |
     18 | cyan    | #56b6c2      |
     19 | white   | #ffffff      |
     20 | bright black | #5c6370 |
     21 
     22 ## Working with this repository
     23 
     24 My solution is based on [this comment][hn-comment] (more info: [here][setup-1]
     25 and [here][setup-2]). A bare repository is initialized on a specified directory
     26 (`$XDG_DATA_HOME/dotfiles/repo.git` in my case) and then it is used as if it was
     27 in the home directory using the `--work-tree` option. I have aliased this git
     28 command with options to `c` (see setup below). The `status.showUntrackedFiles
     29 no` setting is used to avoid seeing all files in the home directory.
     30 
     31 To set up your computer with this repository, run the script `bootstrap.sh`. To
     32 only track a subset of the files on the repository, look at how it's done on the
     33 `bootstrap.sh` script for the `--small` option. I also recommend adding a
     34 `post-merge` hook with the for loop that is run with the `--small` option on the
     35 `bootstrap.sh` script, to ensure it ignores any future files that don't match
     36 the regex.
     37 
     38 ### Notes
     39 
     40 I have also created alises `c-clean` and `c-populate` to hide or show the files
     41 `README.md`, `COPYING` and `bootstrap.sh`. This functions will delete or
     42 override the files on the home directory respectively (be careful!).
     43 
     44 ### Notes for myself...
     45 
     46 Some of the programs you will need on a new installation are the following
     47 (package names for Arch Linux, install with `pacman -S package1 package2 ...`):
     48 
     49 ```
     50 # basic
     51 xf86-video-intel zsh zsh-syntax-highlighting fzf neovim wget man cronie htop sshfs dash pacman-contrib xclip inetutils
     52 # xorg
     53 xorg-server xorg-xinit
     54 # utils
     55 xorg-xrandr xorg-xbacklight alsa-utils alsa-lib alsa-plugins xwallpaper xcape xautolock pulseaudio xorg-xsetroot dunst xdotool udisks2 acpi scrot mlocate rsync feh exfat-utils
     56 # gnome
     57 gnome gnome-extra
     58 # fonts
     59 noto-fonts ttf-font-awesome ttf-dejavu
     60 # software
     61 mpv thunderbird alacritty firefox signal-desktop pass transmission-cli syncthing yt-dlp jq restic
     62 # other
     63 texlive-most texlive-lang biber gtk2 gtk3 gvfs zathura mupdf zathura-pdf-mupdf pdftk
     64 ```
     65 
     66 and don't forget to install `dwm`, `dmenu`, `slock` and `dwmblocks` (by now
     67 hopefully you have your SSH keys set up with the Git server):
     68 
     69 ```sh
     70 mkdir -p ~/.local/src
     71 git clone git@git.oscarbenedito.com:dwm ~/.local/src/dwm
     72 git clone git@git.oscarbenedito.com:dmenu ~/.local/src/dmenu
     73 git clone git@git.oscarbenedito.com:slock ~/.local/src/slock
     74 git clone git@git.oscarbenedito.com:dwmblocks ~/.local/src/blocks
     75 sudo make -C ~/.local/src/dwm install
     76 sudo make -C ~/.local/src/dmenu install
     77 sudo make -C ~/.local/src/slock install
     78 sudo make -C ~/.local/src/blocks install
     79 ```
     80 
     81 Enable PulseAudio and syncthing, download neovim plugins:
     82 
     83 ```
     84 systemctl --user enable pulseaudio.service
     85 sudo systemctl enable "syncthing@$USER.service"
     86 nvim --headless -u NONE -c 'lua require("bootstrap-paq").run()'
     87 ```
     88 
     89 Finally, don't forget to put your wallpaper under
     90 `~/.local/share/dwm/wallpaper.png`.
     91 
     92 ## License
     93 
     94 Copyright (C) 2019-2022 Oscar Benedito
     95 
     96 This repository is licensed under the CC0 1.0 Universal license and therefore is
     97 part of the public domain. To the extent possible under law, the person who
     98 associated CC0 with this work has waived all copyright and related or
     99 neighboring rights to this work. You can find a copy of the CC0 license on the
    100 `COPYING` file or [here][license].
    101 
    102 You can find this repository online at <https://git.oscarbenedito.com/dotfiles>.
    103 
    104 
    105 [hn-comment]: <https://news.ycombinator.com/item?id=11071754>
    106 [setup-1]: <https://www.atlassian.com/git/tutorials/dotfiles>
    107 [setup-2]: <https://www.paritybit.ca/blog/how-i-manage-my-dotfiles>
    108 [license]: <https://creativecommons.org/publicdomain/zero/1.0/>