Skip to content

Commit

Permalink
Adapt installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lgoettgens committed Feb 22, 2024
1 parent 828ddc7 commit 9124ac4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 7 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down

0 comments on commit 9124ac4

Please sign in to comment.