zuc 0.2.0

ZUC Stream Cipher Algorithms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# Development Guide

## Requirements

|               Toolchain               | Version |
| :-----------------------------------: | :-----: |
|      [Rust](https://rustup.rs/)       | ^1.78.0 |
| [just](https://github.com/casey/just) | ^1.36.0 |

## Workflow

### Download source code

```bash
git clone https://github.com/Nugine/zuc.git
cd zuc
```

### Run basic checks and tests

```bash
just dev
```

### Open documentation

```bash
just doc
```

### Run CI checks locally

```bash
just ci
```

## Git

### Commit Message

We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.

### Pull Request

Before creating or updating a pull request, please make sure to run the following commands and resolve any warnings or errors:

```bash
just dev
```