about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@google.com>2019-12-20T20·37+0000
committerVincent Ambo <tazjin@google.com>2019-12-20T20·37+0000
commit8de5d093d8e35b2492c81015dcfcb052d2718614 (patch)
treef4bb5763a39c7059537fc7877e3c0ac15a4d8f69 /README.md
parent03bfe08e1dd9faf48b06cb146bfa446575cde88a (diff)
refactor: Fix a variety of filepaths for repo relayouting r/238
This fixes readTree and the various project builds, as well
as (hopefully) most documentation links inside of the projects.
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 18 insertions, 14 deletions
diff --git a/README.md b/README.md
index d3537bfff722..1b02a99f9adf 100644
--- a/README.md
+++ b/README.md
@@ -20,39 +20,43 @@ Twitter][].
 ## Tools
 
 * `tools/emacs` contains my personal Emacs configuration (packages & config)
-* `tools/aoc2019` contains solutions for a handful of Advent of Code 2019
+* `fun/aoc2019` contains solutions for a handful of Advent of Code 2019
   challenges, before I ran out of interest
 * `tools/blog_cli` contains my tool for writing new blog posts and storing them
   in the DNS zone
-* `tools/kms_pass.nix` is a tiny tool that emulates the user-interface of
-  `pass`, but actually uses Google Cloud KMS for secret decryption
+* `ops/kms_pass.nix` is a tiny tool that emulates the user-interface of `pass`,
+  but actually uses Google Cloud KMS for secret decryption
 
 ## Packages / Libraries
 
-* `overrides/buildGo` implements a Nix library that can build Go software in the
-  style of Bazel's `rules_go`. Go programs in this repository are built using
-  this library.
-* `tools/emacs-pkgs` contains various Emacs libraries that my Emacs setup uses
+* `nix/buildGo` implements a Nix library that can build Go software in the style
+  of Bazel's `rules_go`. Go programs in this repository are built using this
+  library.
+* `tools/emacs-pkgs` contains various Emacs libraries that my Emacs setup uses,
+  for example:
+  * `dottime.el` provides [dottime][https://dotti.me] in the Emacs modeline
+  * `nix-util.el` provides editing utilities for Nix files
+  * `term-switcher.el` is an ivy-function for switching between vterm buffers
 
 ## Services
 
 Services in this repository are deployed on a Google Kubernetes Engine cluster
 using [Nixery]().
 
-* `services/tazblog` contains my blog software (serving at [tazj.in][])
-* `services/cgit-taz` contains a slightly patched version of `cgit` that serves
-  my git web interface at [git.tazj.in][]
-* `services/sync-gcsr` contains a tiny service that synchronises a Google Cloud
+* `web/tazblog` contains my blog software (serving at [tazj.in][])
+* `web/cgit-taz` contains a slightly patched version of `cgit` that serves my
+  git web interface at [git.tazj.in][]
+* `ops/sync-gcsr` contains a tiny service that synchronises a Google Cloud
   Source Repository with a local disk path. My `cgit` setup uses this
   under-the-hood.
-* `services/gemma` contains a no-longer-maintained service that served as an
+* `fun/gemma` contains a no-longer-maintained service that served as an
   experiment in "household task management" - it's kept in here because I find
   it interesting
 
 # Contributing
 
-If you'd like to contribute to any of the tools in here, please send a patch
-(using `git format-patch` or `git send-email`) to `reviews@tazj.in`.
+If you'd like to contribute to any of the tools in here, please check out the
+[contribution guidelines](/tree/docs/CONTRIBUTING.md).
 
 [monorepo]: https://en.wikipedia.org/wiki/Monorepo
 [Nix]: https://nixos.org/nix