Skip to content

Commit

Permalink
README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
erdemeray committed Jun 11, 2024
2 parents 313dc16 + 81292bb commit f215f56
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
10 changes: 10 additions & 0 deletions .github/workflows/cmake-multi-platform.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,17 @@ jobs:

steps:
- uses: actions/checkout@v4

# Add a step to set up Python
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11' # Specify the Python version you need

# Add a step to install Pybind11 using pip
- name: Install Pybind11
run: python -m pip install pybind11

- name: Set reusable strings
# Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
id: strings
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This library, written in C++, offers tools for information reconciliation tailored for continuous-variable quantum key distribution (CV-QKD) systems. It also includes Python bindings for use within Python environments.

## Article

The link to the article will be added soon.

## Quick Start

Follow these steps to set up the project on your local system.
Expand All @@ -25,6 +29,10 @@ cmake ..
make
```

### Documentation

The complete documentation for the library is available at the following link: [Library Documentation](https://information-reconciliation-for-cv-qkd.readthedocs.io/).

## License
The project is open-source, under the GPL-3.0 License.

Expand All @@ -36,4 +44,4 @@ The project is open-source, under the GPL-3.0 License.


## Cite this work as:
E. E. Cil and L. Schmalen, "Rate-adaptive protograph-based raptor-like LDPC code for continuous-variable quantum key distribution," *Proc. Advanced Photonic Congress: Signal Processing in Photonic Communications (SPPCom)*, Québec City, Canada, Jul. 2024
E. E. Cil and L. Schmalen, "Rate-adaptive protograph-based raptor-like LDPC code for continuous-variable quantum key distribution," *Proc. Advanced Photonic Congress: Signal Processing in Photonic Communications (SPPCom)*, Québec City, Canada, Jul. 2024

0 comments on commit f215f56

Please sign in to comment.