From 9124ac4ac22d17945a95f93d76f94d9085626044 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20G=C3=B6ttgens?= Date: Thu, 22 Feb 2024 14:40:35 +0100 Subject: [PATCH] Adapt installation guide --- README.md | 9 +++++++-- docs/src/index.md | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aa55eeb1..ebca08bd 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,16 @@ ## Install -To install this package in Julia: +To install this package in Julia, clone it from github and then run the following command in the Julia REPL from the package directory: ``` -using Pkg; Pkg.add("PBWDeformations") +using Pkg +Pkg.activate(".") +include(joinpath(pwd(), "etc", "add_oscar.jl")) +using PBWDeformations, Oscar ``` +This package depends on a development version of the [Oscar](https://oscar.computeralgebra.de/) package. The `add_oscar.jl` script will add the Oscar package to the current environment. If you want to use the package in a different environment, you can run the `add_oscar.jl` script int the other environment to obtain the specific version of Oscar. + ## Functionality The package will provide both a general framework and specialized functions in order to diff --git a/docs/src/index.md b/docs/src/index.md index 87bcba7f..a51ec70b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -17,11 +17,16 @@ To solve classification problems efficiently, we use representation theoretic id - For some modules of ``\mathfrak{so}_n``, give an explicit basis using arc diagrams or pseudographs (cf. [FM22](@cite)). ## Installation -As this package heavily relies on [Oscar](https://oscar.computeralgebra.de/), it is recommended to install Oscar first ([installation instructions](https://oscar.computeralgebra.de/install/)). Then, install this package via the Julia package manager: +o install this package in Julia, clone it from github and then run the following command in the Julia REPL from the package directory: ``` -] add PBWDeformations +using Pkg +Pkg.activate(".") +include(joinpath(pwd(), "etc", "add_oscar.jl")) +using PBWDeformations, Oscar ``` +This package depends on a development version of the [Oscar](https://oscar.computeralgebra.de/) package. The `add_oscar.jl` script will add the Oscar package to the current environment. If you want to use the package in a different environment, you can run the `add_oscar.jl` script int the other environment to obtain the specific version of Oscar. + ## Outline ```@contents Pages = [