about summary refs log tree commit diff
path: root/tools/nixery/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2022-04-20T14·41+0200
committerclbot <clbot@tvl.fyi>2022-04-20T15·31+0000
commit6716bf018c465f4b943eef0e6716caa7a54940da (patch)
tree8e609da0ed0052f4088250ecc1033c28d35f5d6c /tools/nixery/README.md
parent535ad8732a688bf6ff4c48283d89dae00262a719 (diff)
chore(nixery): Housekeeping for depot compatibility r/3982
Cleans up a whole bunch of things I wanted to get out of the door
right away:

* depot internal references to //third_party/nixery have been replaced
  with //tools/nixery
* cleaned up files from Github
* fixed SPDX & Copyright headers
* code formatting and inclusion in //tools/depotfmt checks

Change-Id: Iea79f0fdf3aa04f71741d4f4032f88605ae415bb
Reviewed-on: https://cl.tvl.fyi/c/depot/+/5486
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
Autosubmit: tazjin <tazjin@tvl.su>
Diffstat (limited to 'tools/nixery/README.md')
-rw-r--r--tools/nixery/README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/tools/nixery/README.md b/tools/nixery/README.md
index cba8ce6b14f6..03515939a9b5 100644
--- a/tools/nixery/README.md
+++ b/tools/nixery/README.md
@@ -4,7 +4,7 @@
 
 -----------------
 
-[![Build Status](https://github.com/tazjin/nixery/actions/workflows/build-and-test.yaml/badge.svg)](https://github.com/tazjin/nixery/actions/workflows/build-and-test.yaml)
+[![Build status](https://badge.buildkite.com/016bff4b8ae2704a3bbbb0a250784e6692007c582983b6dea7.svg?branch=refs/heads/canon)](https://buildkite.com/tvl/depot)
 
 **Nixery** is a Docker-compatible container registry that is capable of
 transparently building and serving container images using [Nix][].
@@ -24,6 +24,15 @@ You can watch the NixCon 2019 [talk about
 Nixery](https://www.youtube.com/watch?v=pOI9H4oeXqA) for more information about
 the project and its use-cases.
 
+The canonical location of the Nixery source code is
+[`//tools/nixery`][depot-link] in the [TVL](https://tvl.fyi)
+monorepository. If cloning the entire repository is not desirable, the
+Nixery subtree can be cloned like this:
+
+    git clone https://code.tvl.fyi/depot.git:/tools/nixery.git
+
+The subtree is infrequently mirrored to `tazjin/nixery` on Github.
+
 ## Demo
 
 Click the image to see an example in which an image containing an interactive
@@ -139,8 +148,9 @@ separate Nix function, which will make it possible to build images directly in
 Nix builds.
 
 [Nix]: https://nixos.org/
-[layering strategy]: https://storage.googleapis.com/nixdoc/nixery-layers.html
+[layering strategy]: https://tazj.in/blog/nixery-layers
 [gist]: https://gist.github.com/tazjin/08f3d37073b3590aacac424303e6f745
 [buildLayeredImage]: https://grahamc.com/blog/nix-and-layered-docker-images
 [public]: https://nixery.dev
+[depot-link]: https://cs.tvl.fyi/depot/-/tree/tools/nixery
 [gcs]: https://cloud.google.com/storage/