tvl-depot/users/wpcarro/README.md
William Carroll e7def7ed68 chore(wpcarro): Simplify README.md
I rewrote my `README.md` most recently to show some managers what type
of side-projects I was working on. After successfully transfering to SRE
internally, I don't need the `README.md` to be a marketing document but
rather a tutorial for my future self. This change is a step in that
direction.

Change-Id: Ieaf0e72c8a33a163e6b6adefd76665ca675e8462
Reviewed-on: https://cl.tvl.fyi/c/depot/+/4791
Tested-by: BuildkiteCI
Reviewed-by: wpcarro <wpcarro@gmail.com>
Autosubmit: wpcarro <wpcarro@gmail.com>
2022-01-08 04:28:35 +00:00

44 lines
1.6 KiB
Markdown

# wpcarro
Welcome to my monorepo.
Herein you will find a variety of libraries, packages, and documents. Some of
this work in finished and other work is incomplete or just a sketch for a
future project.
Where applicable, I try to include `README.md` files in some of the
subdirectories to help orient both myself and any onlookers.
## Sign posts
Below I have outlined a few projects that you might find interesting.
- `boilerplate`: scaffolding for projects. Boilerplate's goal is to reduce the
startup costs of a project.
- `configs`: my dotfiles (e.g. `config.fish`, `init.vim`).
- `emacs`: Emacs is both my preferred text editor and my window manager; with
tens of thousands of lines of Emacs Lisp, you can safely assume that this
directory hosts a lot of libraries and packages.
- `monzo_ynab`: `systemd` timer unit that imports my Monzo (i.e. a U.K.-based
online bank) transactions into the personal finance tool YNAB (i.e.
youneedabudget.com).
- `nixos`: my declarative configuration for my NixOS machines. If you are
unfamiliar with Nix, I recommend reading about the NixOS project.
- `tools`: some scripts and projects that simplify my life.
- `website`: everything required to build my website, https://wpcarro.dev.
## Installation
### Google Machine
- ensure `~/google-briefcase` exists
- read `~/google-briefcase/README.md`
### NixOS Machine
- Ensure Nix is installed.
- Ensure direnv is installed.
- Ensure `~/.password-store` exists.
- Run `.gnupg/export.sh` from a computer with my gpg credentials. Run
`.gnupg/import.sh` from the new machine.
- Consult `Makefile`.