docs(nix/yants): Mention Yants subtree split in README
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.
This commit is contained in:
parent
d97cf260a2
commit
6e7006c061
1 changed files with 9 additions and 5 deletions
|
@ -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`:
|
||||
|
|
Loading…
Reference in a new issue