From 9fce0ce6ee86ffcb38e9f59287bc371c2435114c Mon Sep 17 00:00:00 2001 From: Maria Marchwicka Date: Thu, 22 Jul 2021 23:33:02 +0200 Subject: [PATCH] Update 'README.md' --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 39ced7d..ae727b5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -This project aims to calculate signature functions for knots (cable sums) and was used to prove Lemma 3.2 from a paper "On the slice genus of generalized algebraic knots" (Maria Marchwicka and Wojciech Politarczyk). -The package can be used in interactive mode (see notebooks for examples). +This project allows calculating knot invariants for linear combinations of iterated torus knots. +It was created as part of proof for the main lemma from a paper "On the slice genus of generalized algebraic knots" (Maria Marchwicka and Wojciech Politarczyk). -A knot (cable sum) is encoded as a list where each element (also a list) corresponds to a cable knot. \ No newline at end of file +To recreate calculations that were done for the proof see lemma.ipynb in notebooks. +For a more detailed description see package documentation. \ No newline at end of file