From 4b6d13bbaab0aac79d899f1cc53f752f0fb6e176 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jozef=20=C5=A0imko?= <jozef.simko@student.tuke.sk>
Date: Mon, 19 Feb 2024 17:22:01 +0000
Subject: [PATCH] update readme

---
 OpenSSL & oqsprovider/README.md | 34 ++++++++++++++++++++++++---------
 1 file changed, 25 insertions(+), 9 deletions(-)

diff --git a/OpenSSL & oqsprovider/README.md b/OpenSSL & oqsprovider/README.md
index 4745561..3f1cdd5 100644
--- a/OpenSSL & oqsprovider/README.md	
+++ b/OpenSSL & oqsprovider/README.md	
@@ -1,8 +1,23 @@
-OpenSSL 3.2
+# OpenSSL & liboqs & oqsprovider
+
+## About
+Tento priečinok obsahuje detailný postup inštalácie potrebných knižníc na sprístupnenie PQ algoritmov v OpenSSL 3.2 a vzorové aplikácie klienta a serveru, ktoré využívajú PQ algoritmy pri štandardnej TCP/IP komunikácii s využitím protokolu TLS 1.3.
+
+## Building
+Inštalované a testované na:
+|     Platform    |             OS            |                     compiler                    | cmake | ninja |
+|:-----------------:|:---------------------------:|:------------------------------------------------:|:-------:|:-------:|
+|      Linux      |     Ubuntu 20.04.1 WLS2   |    gcc version 11.4.0 (Ubuntu 11.4.0-1ubuntu1~22.04)   | 1.10.1 | 3.22.1 |
+|     Windows     |     Windows 10.0.19043    | gcc version 14.0.0 20240107 (experimental) (MinGW-W64 x86_64-msvcrt-posix-seh) | 1.11.1 | 3.28.1 |
+
+### :exclamation: **OpenSSL 3.2 je minimálna verzia OpenSSL, ktorá umožňuje využívať PQ algoritmy pri komunikácii** :exclamation:
+
+### LINUX
+#### OpenSSL 3.2
 ```
 sudo apt install build-essential checkinstall -y
 
-git clone https://github.com/openssl/openssl.git (verzia 3.3.0-dev (21.01.2024)
+git clone https://github.com/openssl/openssl.git
 
 https://github.com/openssl/openssl/releases/download/openssl-3.2.0/openssl-3.2.0.tar.gz
 tar -xvf openssl-3.2.0.tar.gz
@@ -16,11 +31,11 @@ export LD_LIBRARY_PATH="/usr/local/lib64:$PATH"
 
 cd /etc/ld.so.conf.d/
 sudo touch openssl-3.2.0.conf
-echo "/usr/local/lib64" | sudo tee -a openssl-3.1.2.conf
+echo "/usr/local/lib64" | sudo tee -a openssl-3.2.0.conf
 sudo ldconfig -v
 ```
 
-LIBOQS
+#### LIBOQS
 ```
 sudo apt install astyle cmake gcc ninja-build libssl-dev python3-pytest python3-pytest-xdist unzip xsltproc doxygen graphviz python3-yaml valgrind -y
 git clone https://github.com/open-quantum-safe/liboqs.git
@@ -37,7 +52,7 @@ echo "/usr/local/lib" | sudo tee -a liboqs.conf
 sudo ldconfig -v
 ```
 
-OQS PROVIDER
+#### OQS PROVIDER
 ```
 git clone https://github.com/open-quantum-safe/oqs-provider.git
 cd oqs-provider
@@ -46,12 +61,15 @@ cmake --build _build
 sudo cmake --install _build
 ```
 
+
 ```
 cd /usr/local/ssl/
 sudo nano openssl.cnf
 ```
 
-// add 
+- po inštalácii pridáme do konfiguračného súboru modul, ktorý permanentne aktivuje OQS provider a jeho funkcie pri používani OpenSSL 
+- `Note: Be sure to always activate the "default" provider`
+- v prípade potreby je možné konfiguračný súbor nahradiť súborom z tohto priečinku
 ```
 [provider_sect]
 default = default_sect
@@ -59,10 +77,8 @@ oqsprovider = oqsprovider_sect
 [oqsprovider_sect]
 activate = 1
 ```
-Note: Be sure to always activate either the "default"
 
-
-WIN
+### WINDOWS
 
 Winlibs