diff --git a/README.md b/README.md index 35c4f77..7144a87 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,17 @@ # SAGEMATH module: superelliptic curves and their abelian p-group covers -## Basic information - ## Usage -The main file is init.sage. In order to use it, type: +The main file is *init.sage*. In order to use it, navigate to the folder with the module (*cd yourpath/DeRhamComputation*) and type: -```sage: load('init.sage')``` +```load('init.sage')``` The main two "packages" are intended for: - superelliptic curves, - $(\mathbb Z/p)^n$-covers of superelliptic curves. -See below and the file examples.sage for examples. +See below and the file *examples.sage* for examples. Also, folders with name *tests* contain tests, which might be useful for learning. ## Superelliptic curves @@ -33,7 +31,7 @@ points at infinity and that $f(x)$ must be separable in order for $C$ to be smoo There are three auxilliary classes: superelliptic_function (for functions defined on superelliptic curves), superelliptic_form (for forms defined on superelliptic curves) and superelliptic_cech (for cech cocycles for the de Rham cohomology on superelliptic curves). -For example, in order to define the function $x + 2y + 1$ on our curve $C$ we can define it like this: +For example, we can define the function $x + 2y + 1$ on our curve $C$ like this: ``` Rxy. = PolynomialRing(F, 2)