about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@google.com>2020-05-16T11·24+0100
committerVincent Ambo <tazjin@google.com>2020-05-16T11·37+0100
commit6e7006c061da1ccbacf6f92f2a6464f63c4ded44 (patch)
tree7da503864a78eaa161950223c5289be1bf43429a
parentd97cf260a2547a53853dafee896176c5814ef482 (diff)
docs(nix/yants): Mention Yants subtree split in README r/720
This subtree split makes it possible for people to clone only
yants (similar to the kontemplate and journaldriver branches).

The subtree continues the history of the old git repository.
-rw-r--r--nix/yants/README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/nix/yants/README.md b/nix/yants/README.md
index 48bf3f7b37..d17ea61b52 100644
--- a/nix/yants/README.md
+++ b/nix/yants/README.md
@@ -21,29 +21,33 @@ Currently lacking:
 
 ## Primitives & simple polymorphism
 
-![simple](yants/screenshots/simple.png)
+![simple](/about/nix/yants/screenshots/simple.png)
 
 ## Structs
 
-![structs](yants/screenshots/structs.png)
+![structs](/about/nix/yants/screenshots/structs.png)
 
 ## Nested structs!
 
-![nested structs](yants/screenshots/nested-structs.png)
+![nested structs](/about/nix/yants/screenshots/nested-structs.png)
 
 ## Enums!
 
-![enums](yants/screenshots/enums.png)
+![enums](/about/nix/yants/screenshots/enums.png)
 
 ## Functions!
 
-![functions](yants/screenshots/functions.png)
+![functions](/about/nix/yants/screenshots/functions.png)
 
 # Usage
 
 Yants can be imported from its `default.nix`. A single attribute (`lib`) can be
 passed, which will otherwise be imported from `<nixpkgs>`.
 
+TIP: You do not need to clone my whole repository to use Yants! It is split out
+into the `nix/yants` branch which you can clone with, for example, `git clone -b
+nix/yants https://git.tazj.in yants`.
+
 Examples for the most common import methods would be:
 
 1. Import into scope with `with`: