Skip to content

Commit

Permalink
Add nix docs to quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
aidenfoxivey committed Nov 5, 2024
1 parent 03b6a60 commit c929e28
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ liboqs is an open source C library for quantum-safe cryptographic algorithms.
- [Linux and Mac](#linux-and-mac)
- [Windows](#windows)
- [Cross compilation](#cross-compilation)
- [Nix Flake][#nix-flake]
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
Expand Down Expand Up @@ -167,6 +168,44 @@ If you want to create Visual Studio build files, e.g., if not using `ninja`, be

You can cross compile liboqs for various platforms. Detailed information is available [in the Wiki](https://github.com/open-quantum-safe/liboqs/wiki/Platform-specific-notes-for-building-liboqs#cross-compiling).

### Nix Flake

Nix is a tool that makes builds and developer environments deterministic. With just Nix installed, you can install `liboqs` using one command.

Need to install Nix? Consider using the [Lix installer](https://git.lix.systems/lix-project/lix-installer), a modern, community-focused implementation of the Nix tool, available for Linux and MacOS.

#### Building with Nix

You can build this easily with `nix build github:open-quantum-safe/liboqs/` if you only need the artifact `liboqs.a`.

If you want to build from a local version of the code, clone the repository and then run one of the following commands (depending on which toolchain you want to use and style of library you want to build):

```bash
# build a shared library using gcc
nix build .#gcc.shared

# build a static library using gcc
nix build .#gcc.static

# build a shared library using clang
nix build .#clang.shared

# build a static library using clang
nix build .#clang.static
```

#### Running the developer shell

In order to run a developer shell with the specified version of each dependency, you can run `nix develop`:

```bash
# using clang toolchain
nix develop .#clang

# using gcc toolchain
nix develop .#gcc
```

## Documentation

More detailed information on building, optional build parameters, example applications, coding conventions and more can be found in the [wiki](https://github.com/open-quantum-safe/liboqs/wiki).
Expand Down

0 comments on commit c929e28

Please sign in to comment.