Skip to content

Commit df44eab

Browse files
committed
Version placeholder
1 parent 2ffe918 commit df44eab

3 files changed

Lines changed: 31 additions & 18 deletions

File tree

_config.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ kramdown:
2626
auto_ids: true
2727
hard_wrap: false
2828

29+
cracoversion: 2.0.0
30+
mathversion: 2.0.0
31+
2932
# exclude from jekyll site
3033
exclude:
3134
- vendor
@@ -34,4 +37,4 @@ exclude:
3437
- Gemfile.lock
3538
- README.md
3639
- Dockerfile
37-
- LICENSE
40+
- LICENSE

getting-started/5-minute-tutorial.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@
270270
"cell_type": "markdown",
271271
"metadata": {},
272272
"source": [
273-
"For more information on serialization, see [our documentation regarding `Representation`s](https://cryptimeleon.github.io/docs/representations.html)."
273+
"For more information on serialization, see [our documentation regarding `Representation`s](https://cryptimeleon.org/docs/representations.html)."
274274
]
275275
},
276276
{

getting-started/installation.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,18 @@ This process depends on your project structure and dependency management; theref
1313
We assume that you are familiar with the dependency management of your build tool.
1414

1515
## Maven
16-
For adding for example Craco 1.0.0 to your project, add this dependency:
16+
For adding for example the newest version of Craco and Math to your project, add this dependency:
1717

1818
```xml
19+
<dependency>
20+
<groupId>org.cryptimeleon</groupId>
21+
<artifactId>math</artifactId>
22+
<version>{{site.mathversion}}</version>
23+
</dependency>
1924
<dependency>
2025
<groupId>org.cryptimeleon</groupId>
2126
<artifactId>craco</artifactId>
22-
<version>1.0.0</version>
27+
<version>{{site.cracoversion}}</version>
2328
</dependency>
2429
```
2530

@@ -31,25 +36,30 @@ If you want to use the mclwrap library, you also need to [install the MCL java b
3136

3237
## Gradle
3338

34-
We asssume you have set up a Gradle project with a `build.gradle` file.
39+
We assume you have set up a Gradle project with a `build.gradle` file.
3540
The libraries are hosted on Maven Central.
36-
Therefore, you need to add `mavenCentral()` to the `repositories` section of your `build.gradle` file.
3741

38-
Then, you need to decide which library you want to use. Once you have decided, you need to add it as a dependency.
39-
For example, for Craco version 1.0.0, you would add `implementation group: 'org.cryptimeleon', name: 'craco', version: '1.0.0'`
40-
to the `dependencies` section in the `build.gradle` file.
41-
The group id is common to all Cryptimeleon libraries.
42-
The name of the library generally corresponds to the name of the repository.
42+
Example gradle file:
43+
```gradle
44+
plugins {
45+
id 'java-library'
46+
}
47+
48+
repositories {
49+
mavenCentral()
50+
}
51+
52+
dependencies {
53+
implementation 'org.cryptimeleon:math:{{site.mathversion}}'
54+
implementation 'org.cryptimeleon:craco:{{site.cracoversion}}'
55+
}
56+
```
4357

4458
If you want to use the mclwrap library, you also need to [install the MCL java bindings](#mclwrap-installation).
4559

4660
# Mclwrap Installation
4761

48-
For benchmarking you will probably want to use an efficient cryptographic pairing implementation.
49-
The Cryptimeleon Math library does provide a selection of pairings, but these are orders of magnitude less efficient than other, more optimized implementations.
50-
51-
An efficient pairing implementation is provided by our wrapper around the [MCL library's](https://github.com/herumi/mcl) implementation of the BN254 curve.
52-
This wrapper is provided by the Cryptimeleon Mclwrap library.
62+
For a much more efficient bilinear group implementation, use our wrapper around the [MCL library](https://github.com/herumi/mcl)'s BN254 curve.
5363

54-
To use the MCL wrapper library in your project, you need to install the Java bindings for MCL.
55-
See [here](https://github.com/cryptimeleon/mclwrap/blob/master/README.md) for installation instructions.
64+
To use the MCL wrapper library in your project, you need to (1) compile and install MCL, and then (2) add the dependency to our the Java bindings.
65+
This process is explained [here](https://github.com/cryptimeleon/mclwrap/blob/main/README.md).

0 commit comments

Comments
 (0)