From fd28cc8b9540adacf6bd998f5628d234c3cd3b44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Kube=C4=8Dka?= <32225978+martinkubecka@users.noreply.github.com> Date: Sun, 27 Jun 2021 15:33:20 +0200 Subject: [PATCH] README update --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index efb20a0..eedcc25 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # Polynomial-Factorization -Command line program for polynomial factorization mod p^n \ No newline at end of file +**Command line program for polynomial factorization mod p^n** + +--- +## :clipboard: Usage Manual + +- The user selects an option from the menu: 2 = factorization, 1 = helper, 0 = exit +- After selecting the factorization, the user is prompted to enter any prime number and then a positive integer greater than 1 (this positive number determines the extension of the finite field *GF(p^n)*). +- In the next step, it is necessary to enter the mononic polynomial, which we will factorize. +- The screen displays an evaluation of whether the entered polynomial is reducible or irreducible. +- In the case of a reducible polynomial, the user is provided with a list of factors in a readable form as well as in a format provided by the [NTL](https://libntl.org/) library. + +
+ +
+ +### Help +- If the user selects a help option from the main menu, examples of the polynomial format used by the application are displayed. +- As we can see, the coefficients belonging to *x^0* to *x^n* are written in square brackets in this order. + ++ +
+ +--- +## :running: Running Polynomial-Factorization +