Skip to content

Commit

Permalink
update readme crypto3 sub folders
Browse files Browse the repository at this point in the history
  • Loading branch information
akokoshn committed Jan 3, 2025
1 parent 9641c12 commit 88fc6b6
Show file tree
Hide file tree
Showing 34 changed files with 417 additions and 373 deletions.
2 changes: 1 addition & 1 deletion crypto3/docs/manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ root
│ ├── block: block ciphers
│ ├── blueprint: components and circuits for zk schemes
│ ├── codec: encoding/decoding algorithms
│ ├── containers: containers and generic commitment schemes for accumulating data, includes Merkle Tree
│ ├── containers: containers for accumulating data, includes Merkle Tree
│ ├── hash: hashing algorithms
│ ├── kdf: key derivation functions
│ ├── mac: message authentication codes
Expand Down
27 changes: 0 additions & 27 deletions crypto3/libs/algebra/README.md

This file was deleted.

27 changes: 27 additions & 0 deletions crypto3/libs/algebra/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# =nil; Foundation's Algebraic Constructions Module

=nil; Foundation's Algebraic Constructions module.

Contains:
* Finite fields
* Curves
* Pairing
* Constexpr BLAS.

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

### Internal

* [Multiprecision](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/multiprecision).

### External
* [Boost](https://boost.org) (>= 1.73)
41 changes: 0 additions & 41 deletions crypto3/libs/blueprint/README.md

This file was deleted.

24 changes: 24 additions & 0 deletions crypto3/libs/blueprint/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Circuit Definition Library for =nil; Foundation's Cryptography Suite

=nil; Foundation's Circuit Definition library which provides interfaces for generating ZK circuits used in proof generation. It holds information about the circuit itself, its gates, constraints, and other fixed expressions, public and private assignments needed by the ZK-SNARK system.

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

### Internal

* [Algebra](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/algebra).
* [Zk](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/zk).
* [Random](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/random).
* [Hash](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/hash).

### External
* [Boost](https://boost.org) (>= 1.73)
21 changes: 0 additions & 21 deletions crypto3/libs/containers/README.md

This file was deleted.

17 changes: 17 additions & 0 deletions crypto3/libs/containers/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Containers for =nil; Foundation's Cryptography Suite

Containers using =nil; Foundation's cryptography suite.

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

### External
* [Boost](https://boost.org) (>= 1.73)
4 changes: 0 additions & 4 deletions crypto3/libs/hash/README.md

This file was deleted.

18 changes: 18 additions & 0 deletions crypto3/libs/hash/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Hashes for =nil; Foundation's Cryptography Suite

Hashes for =nil; Foundation's cryptography suite.

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

### External
* [Boost](https://boost.org) (>= 1.73)

27 changes: 0 additions & 27 deletions crypto3/libs/marshalling/algebra/README.md

This file was deleted.

25 changes: 25 additions & 0 deletions crypto3/libs/marshalling/algebra/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Marshalling utilities for =nil;Crypto3 Algebra

This module provides extension of [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling) utilities for [=nil;Crypto3 Algebra](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/algebra)

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

### Internal

* [Multiprecision](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/multiprecision)
* [Algebra](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/algebra)
* [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling)
* [=nil;Crypto3 Multiprecision Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling/multiprecision)

### External

* [Boost](https://boost.org) (>= 1.74)
3 changes: 0 additions & 3 deletions crypto3/libs/marshalling/containers/README.md

This file was deleted.

17 changes: 17 additions & 0 deletions crypto3/libs/marshalling/containers/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Marshalling utilities for =nil;Crypto3 containers - Merkle trees
This module provides extension of [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling) utilities for [=nil;Crypto3 Containers](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/containers)

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies
### External

* [Boost](https://boost.org) (>= 1.74)

Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
This library is used throughout the project to transform data from one type to another.
To define representation rules for custom type we use template-defined pseudo-DSL.

## Building
## Usage

This library uses Boost CMake build modules (https://github.com/BoostCMake/cmake_modules.git).
This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/BoostCMake/cmake_modules.git) as submodule to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/BoostCMake/cmake_modules.git) as submodules to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/BoostCMake/cmake_modules.git) (Look at [crypto3](https://github.com/nilfoundation/crypto3.git) for the example)
1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

Expand Down
3 changes: 0 additions & 3 deletions crypto3/libs/marshalling/math/README.md

This file was deleted.

17 changes: 17 additions & 0 deletions crypto3/libs/marshalling/math/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Marshalling utilities for =nil;Crypto3 math primitives - polynomials and terms
This module provides extension of [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling) utilities for [=nil;Crypto3 Math](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/math)

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies
### External

* [Boost](https://boost.org) (>= 1.74)

25 changes: 0 additions & 25 deletions crypto3/libs/marshalling/multiprecision/README.md

This file was deleted.

23 changes: 23 additions & 0 deletions crypto3/libs/marshalling/multiprecision/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Marshalling utilities for =nil;Crypto3 Multiprecision

This module provides extension of [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling) utilities for [=nil;Crypto3 Multiprecision](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/multiprecision)

## Usage

This library uses Boost CMake build modules (https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake).
To actually include this library in a project it is required to:

1. Add [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
2. Add all the internal dependencies using [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) to target project repository.
3. Initialize parent project with [CMake Modules](https://github.com/NilFoundation/placeholder/tree/master/crypto3/cmake) (Look at [crypto3](https://github.com/NilFoundation/placeholder/tree/master/crypto3) for the example)

## Dependencies

### Internal

* [Multiprecision](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/multiprecision)
* [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling)

### External

* [Boost](https://boost.org) (>= 1.81)
29 changes: 0 additions & 29 deletions crypto3/libs/marshalling/zk/README.md

This file was deleted.

Loading

0 comments on commit 88fc6b6

Please sign in to comment.