mascully/vanth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

📝 README.md, varo: Fix documentation errors and add new README

Browse source 
- Corrected `Data::<ty()` to `Data::ty()` and added quotes around the example string in main README.
- Changed "derivation" to "derive macro" in the main README explanation.
- Updated all Nix run commands to use full `git+https` URLs with `.git` extension.
- Created a new README for the `varo` crate describing its planned purpose.
This commit is contained in:
Markus Scully 2025-08-11 13:23:16 +03:00
parent ff57ee8deb
commit b927702ee2
Signed by: mascully
GPG key ID: 93CA5814B698101C
2 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -25,9 +25,9 @@ struct Data {
}
```
This generates a method `Vanth::ty()` which returns a `vanth::Ty`. This should represent the type's fully qualified name - its module path followed by the type itself and any generics it has. E.g. `Data::<ty().to_string()` could return `my::crate::module::Data`.
This generates a method `Vanth::ty()` which returns a `vanth::Ty`. This should represent the type's fully qualified name - its module path followed by the type itself and any generics it has. E.g. `Data::ty().to_string()` could return `"my::crate::module::Data"`.
The derivation only works for basic types right now and is not implemented for `std` types. Moving or renaming types or modules will change the type name, necessitating a database migration. This is not supported yet.
The derive macro only works for basic types right now and is not implemented for `std` types. Moving or renaming types or modules will change the type name, necessitating a database migration. This is not supported yet.
This should be used with caution. There are good reasons why `std::any::TypeId` is opaque.
@ -47,9 +47,9 @@ let my_data: Data = store.get_from_hash(hash).unwrap();
## CLI usage
You can run the Vanth CLI with Nix using `nix run https://git.mascully.com/mascully/vanth`.
You can run the Vanth CLI with Nix using `nix run git+https://git.mascully.com/mascully/vanth.git`.
Use `--` to pass arguments, e.g. `nix run https://git.mascully.com/mascully/vanth -- --help`.
Use `--` to pass arguments, e.g. `nix run git+https://git.mascully.com/mascully/vanth.git -- --help`.
### Syntax

5
crates/varo/README.md Normal file
View file

@ -0,0 +1,5 @@
# Varo
Varo is planned to be a testing framework for Vanth.
It is not useable yet.