Skip to content

Commit 0e45016

Browse files
committed
Further minor adaptions to unify documentation
1 parent fd77083 commit 0e45016

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[<img alt="build" src="https://img.shields.io/github/actions/workflow/status/qfall/math/push.yml?branch=main&style=for-the-badge" height="20">](https://github.com/qfall/math/actions/workflows/push.yml)
77
[<img alt="license" src="https://img.shields.io/badge/License-MPL_2.0-blue.svg?style=for-the-badge" height="20">](https://github.com/qfall/math/blob/dev/LICENSE)
88

9-
`qFALL` is a prototyping library for lattice-based constructions.
9+
`qFALL` is a prototyping library for lattice-based cryptography.
1010
This `math`-crate is a memory-safe wrapper of [FLINT](https://flintlib.org/) in Rust, which provides several additional features often used in lattice-based cryptography. This crate is the foundation of the [qFALL project](https://qfall.github.io) containing further crates for prototyping of lattice-based cryptography.
1111

1212
## Quick-Start

src/lib.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2023 Marcel Luca Schmidt
1+
// Copyright © 2023 Marcel Luca Schmidt, Niklas Siemer
22
//
33
// This file is part of qFALL-math.
44
//
@@ -15,11 +15,10 @@
1515
//! - Rationals such as [Q](rational::Q), [`MatQ`](rational::MatQ), [`PolyOverQ`](rational::PolyOverQ).
1616
//!
1717
//! The `qFALL` project contains two more crates called [`qFALL-tools`](https://crates.io/crates/qfall-tools)
18-
//! and [`qFALL-schemes`](https://github.com/qfall/schemes) to support prototyping.
18+
//! and [`qFALL-schemes`](https://crates.io/crates/qfall-schemes) to support prototyping.
1919
//! - Find further information on [our website](https://qfall.github.io/).
2020
//! - We recommend [our tutorial](https://qfall.github.io/book) to start working with qFALL.
2121
//!
22-
//!
2322
//! ## Quick Example
2423
//! ```
2524
//! use qfall_math::{integer_mod_q::MatZq, integer::MatZ};

0 commit comments

Comments
 (0)