# camellia-zig

**Repository Path**: nine-fox/camellia-zig

## Basic Information

- **Project Name**: camellia-zig
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-19
- **Last Updated**: 2024-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
SPDX-FileCopyrightText: 2024 Shun Sakai

SPDX-License-Identifier: Apache-2.0 OR MIT
-->

# camellia-zig

[![CI][ci-badge]][ci-url]

**camellia-zig** is an implementation of the [Camellia] block cipher written in
pure [Zig].

## Usage

Add this package to your `build.zig.zon`:

```sh
zig fetch --save git+https://github.com/sorairolake/camellia-zig.git
```

Add the following to your `build.zig`:

```zig
const camellia = b.dependency("camellia", .{});
exe.root_module.addImport("camellia", camellia.module("camellia"));
```

### Documentation

To build the documentation:

```sh
zig build doc
```

The result is generated in `zig-out/docs`.

If you want to preview this, run a HTTP server locally. For example:

```sh
python -m http.server -d zig-out/docs
```

Then open `http://localhost:8000/` in your browser.

## Zig version

This library is compatible with Zig version 0.13.0.

## Source code

The upstream repository is available at
<https://github.com/sorairolake/camellia-zig.git>.

## Changelog

Please see [CHANGELOG.adoc].

## Contributing

Please see [CONTRIBUTING.adoc].

## License

Copyright &copy; 2024 Shun Sakai (see [AUTHORS.adoc])

This library is distributed under the terms of either the _Apache License 2.0_
or the _MIT License_.

This project is compliant with version 3.2 of the [_REUSE Specification_]. See
copyright notices of individual files for more details on copyright and
licensing information.

[ci-badge]: https://img.shields.io/github/actions/workflow/status/sorairolake/camellia-zig/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI
[ci-url]: https://github.com/sorairolake/camellia-zig/actions?query=branch%3Adevelop+workflow%3ACI++
[Camellia]: https://info.isl.ntt.co.jp/crypt/eng/camellia/
[Zig]: https://ziglang.org/
[CHANGELOG.adoc]: CHANGELOG.adoc
[CONTRIBUTING.adoc]: CONTRIBUTING.adoc
[AUTHORS.adoc]: AUTHORS.adoc
[_REUSE Specification_]: https://reuse.software/spec/