Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Commit

Permalink
Add readme's for utils
Browse files Browse the repository at this point in the history
  • Loading branch information
Remco Bloemen committed Oct 7, 2019
1 parent eb68f21 commit 78c9fe9
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[![Crates.io](https://img.shields.io/crates/l/zkp-stark)](/License.md)
[![](https://docs.rs/zkp-stark/badge.svg)](https://docs.rs/zkp-stark)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/starkcrypto)](https://circleci.com/gh/0xProject/starkcrypto)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/starkcrypto)](https://codecov.io/gh/0xProject/starkcrypto)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/OpenZKP)](https://circleci.com/gh/0xProject/OpenZKP)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/OpenZKP)](https://codecov.io/gh/0xProject/OpenZKP)

OpenZKP - pure Rust implementations of Zero-Knowledge Proof systems.

Expand Down Expand Up @@ -33,7 +33,7 @@ and some others, see [features and limitations](#features-and-limitations) below
| [`criterion-utils`](/utils/criterion-utils) | [![Crates.io](https://img.shields.io/crates/v/criterion-utils?label=)](https://crates.io//) | Criterion helpers to benchmark over size and number of processors. |
| [`error-utils`](/utils/error-utils) | [![Crates.io](https://img.shields.io/crates/v/criterion-utils?label=)](https://crates.io//) | Assertion like macros for returning `Result::Err`. |
| [`logging-allocator`](/utils/logging-allocator) | [![Crates.io](https://img.shields.io/crates/v/criterion-utils?label=)](https://crates.io//) | Wrapper around the system allocator that logs large allocations. |
| [`mmap-vec`](/utils/mmap-vec) | [![Crates.io](https://img.shields.io/crates/v/criterion-utils?label=)](https://crates.io//) | Replacement for `Vec` that uses file-backed storage. |
| [`mmap-vec`](/utils/mmap-vec) | [![Crates.io](https://img.shields.io/crates/v/criterion-utils?label=)](https://crates.io//) | Substitute for `Vec` that uses file-backed storage. |
| [`macros-lib`](/utils/macros-lib) | ![Unpublished](https://img.shields.io/badge/-unpublished-lightgrey) | Library of procedural macros implemented using `proc_macro2` |
| [`macros-impl`](/utils/macros-impl) | ![Unpublished](https://img.shields.io/badge/-unpublished-lightgrey) | Implementation crate for `proc_macro_hack` |
| [`macros-decl`](/utils/macros-decl) | ![Unpublished](https://img.shields.io/badge/-unpublished-lightgrey) | Procedural macros. |
Expand Down
8 changes: 8 additions & 0 deletions utils/logging-allocator/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Logging allocator

[![Crates.io](https://img.shields.io/crates/l/zkp-logging-allocator)](/License.md)
[![](https://docs.rs/zkp-logging-allocator/badge.svg)](https://docs.rs/zkp-logging-allocator)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/OpenZKP)](https://circleci.com/gh/0xProject/OpenZKP)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/OpenZKP)](https://codecov.io/gh/0xProject/OpenZKP)

Wrapper around the system allocator that logs large allocations.
9 changes: 9 additions & 0 deletions utils/macros-decl/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# OpenZKP Macro Declarations

[![Crates.io](https://img.shields.io/crates/l/zkp-logging-allocator)](/License.md)
[![](https://docs.rs/zkp-logging-allocator/badge.svg)](https://docs.rs/zkp-logging-allocator)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/OpenZKP)](https://circleci.com/gh/0xProject/OpenZKP)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/OpenZKP)](https://codecov.io/gh/0xProject/OpenZKP)

Procedural macros for OpenZKP.

8 changes: 8 additions & 0 deletions utils/macros-impl/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# OpenZKP Macro Implementations

[![Crates.io](https://img.shields.io/crates/l/zkp-macros-impl)](/License.md)
[![](https://docs.rs/zkp-macros-impl/badge.svg)](https://docs.rs/zkp-macros-impl)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/OpenZKP)](https://circleci.com/gh/0xProject/OpenZKP)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/OpenZKP)](https://codecov.io/gh/0xProject/OpenZKP)

Implementation crate for `proc_macro_hack`.
9 changes: 9 additions & 0 deletions utils/macros-lib/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# OpenZKP Macro Library

[![Crates.io](https://img.shields.io/crates/l/zkp-macros-lib)](/License.md)
[![](https://docs.rs/zkp-macros-lib/badge.svg)](https://docs.rs/zkp-macros-lib)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/OpenZKP)](https://circleci.com/gh/0xProject/OpenZKP)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/OpenZKP)](https://codecov.io/gh/0xProject/OpenZKP)

Library of procedural macros implemented using `proc_macro2`.

8 changes: 8 additions & 0 deletions utils/mmap-vec/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Mmap Vec

[![Crates.io](https://img.shields.io/crates/l/zkp-macros-lib)](/License.md)
[![](https://docs.rs/zkp-macros-lib/badge.svg)](https://docs.rs/zkp-macros-lib)
[![CircleCI](https://img.shields.io/circleci/build/github/0xProject/OpenZKP)](https://circleci.com/gh/0xProject/OpenZKP)
[![Codecov](https://img.shields.io/codecov/c/gh/0xproject/OpenZKP)](https://codecov.io/gh/0xProject/OpenZKP)

Substitute for `Vec` that uses file-backed storage.

0 comments on commit 78c9fe9

Please sign in to comment.