vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
arti/crates/arti-config/README.md

23 lines
657 B
Markdown
Raw Normal View History

run ./maint/readmes.sh
2021-11-29 11:29:28 +00:00
# arti-config
Move top-level configuration downwards from `arti` to `arti-config`. To do this at all neatly, I had to split out `tor-config` from `arti-config` again, and putting the lower level stuff (paths, builder errors) into tor-config. I also changed our use of derive_builder to always use a common error type, to avoid error type proliferation.
2021-11-17 19:16:55 +00:00
run ./maint/readmes.sh
2021-11-29 11:29:28 +00:00
`arti-config`: Tools for configuration management in Arti
Move top-level configuration downwards from `arti` to `arti-config`. To do this at all neatly, I had to split out `tor-config` from `arti-config` again, and putting the lower level stuff (paths, builder errors) into tor-config. I also changed our use of derive_builder to always use a common error type, to avoid error type proliferation.
2021-11-17 19:16:55 +00:00
## Overview
This crate is part of
[Arti](https://gitlab.torproject.org/tpo/core/arti/), a project to
implement [Tor](https://www.torproject.org/) in Rust.
It provides a client configuration tool using using `serde` and `config`,
plus extra features defined here for convenience.
Update README.md files from rustdoc.
2022-03-01 13:30:53 +00:00
## ⚠ Stability Warning ⚠
The design of this crate, and of the configuration system for
Arti, is likely to change significantly before the release of Arti
1.0.0. For more information see ticket [#285].
[#285]: https://gitlab.torproject.org/tpo/core/arti/-/issues/285
Move top-level configuration downwards from `arti` to `arti-config`. To do this at all neatly, I had to split out `tor-config` from `arti-config` again, and putting the lower level stuff (paths, builder errors) into tor-config. I also changed our use of derive_builder to always use a common error type, to avoid error type proliferation.
2021-11-17 19:16:55 +00:00
License: MIT OR Apache-2.0