Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 833 B
Newer Older
  • Learn to ignore specific revisions
    • Martin Stiemerling's avatar
    Initial commit
    Martin Stiemerling committed
    1 2 
    # Costaquanta
    Malte Bauch's avatar
    Display badges for coverage and pipeline status correctly within README.md  
    Malte Bauch committed
    3 4 
    ![Pipeline Status](https://code.fbi.h-da.de/danet/costaquanta/badges/main/pipeline.svg)
![coverage](https://code.fbi.h-da.de/danet/costaquanta/badges/main/coverage.svg)
    Neil-Jocelyn Schark's avatar
    Resolve "Add code coverage checks and badges"  
    Neil-Jocelyn Schark committed
    5
    Neil-Jocelyn Schark's avatar
    Initialize Repo and v1 of all APIs  
    Neil-Jocelyn Schark committed
    6 7 8 
    This repository is used for development and testing of QKDN software.
It's use-case is research and development only.
If you are interested in production grade QKDN software, please feel free to contact us.
    Martin Stiemerling's avatar
    Initial commit
    Martin Stiemerling committed
    9
    Neil-Jocelyn Schark's avatar
    Initialize Repo and v1 of all APIs  
    Neil-Jocelyn Schark committed
    10 
    ## Overview
    Martin Stiemerling's avatar
    Initial commit
    Martin Stiemerling committed
    11
    Neil-Jocelyn Schark's avatar
    Initialize Repo and v1 of all APIs  
    Neil-Jocelyn Schark committed
    12 
    This repository is separated into different parts, mainly API definitions and code.
    André Sterba's avatar
    Init coding guidelines  
    André Sterba committed
    13 
    We follow a SDN approach which is _controller centric_.
    Neil-Jocelyn Schark's avatar
    Initialize Repo and v1 of all APIs  
    Neil-Jocelyn Schark committed
    14 
    This means that a central `QKDN-Controller` is responsible to manage and configure the network.
    Martin Stiemerling's avatar
    Initial commit
    Martin Stiemerling committed
    15
    Neil-Jocelyn Schark's avatar
    Initialize Repo and v1 of all APIs  
    Neil-Jocelyn Schark committed
    16 
    - [API v1](api/_Docs/v1/Readme.md)
    André Sterba's avatar
    Init coding guidelines  
    André Sterba committed
    17 18 
    - [Logging Guide](docs/Logging.md)
- [Tracing Guide](docs/Tracing.md)
    Neil-Jocelyn Schark's avatar
    Resolve "Definition of Done"  
    Neil-Jocelyn Schark committed
    19 
    - [Definition of Done](docs/dod.md)
    André Sterba's avatar
    Resolve "Add documentation about the shutdown process"  
    André Sterba committed
    20 
    - [Graceful Shutdown](docs/graceful-shutdown.md)