about summary refs log tree commit diff
path: root/views/kit/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'views/kit/README.md')
-rw-r--r--views/kit/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/views/kit/README.md b/views/kit/README.md
new file mode 100644
index 0000000000..9fb32efb4b
--- /dev/null
+++ b/views/kit/README.md
@@ -0,0 +1,22 @@
+The TVL Kit
+===========
+
+This folder contains a publicly available version of the core TVL
+tooling, currently comprising of:
+
+* `buildkite`: TVL tooling for dynamically generating Buildkite
+  pipelines with Nix.
+* `buildGo`: Nix-based build system for Go.
+* `readTree`: Nix library to dynamically compute attribute trees
+  corresponding to the physical layout of a repository.
+* `besadii`: Configurable Gerrit/Buildkite integration hook.
+
+It can be accessed via git by cloning it as such:
+
+    git clone https://code.tvl.fyi/depot.git:workspace=views/kit.git tvl-kit
+
+If you are looking at this within the TVL depot, you can see the
+[josh][] configuration in `workspace.josh`. You will find the projects
+at slightly different paths within the depot.
+
+[josh]: https://github.com/josh-project/josh/