Commit aa60000f authored by Vyush Agarwal's avatar Vyush Agarwal
Browse files

added installation and usage info.

parent 62607d47
Pipeline #432653397 passed with stages
in 11 minutes and 13 seconds
......@@ -3,3 +3,25 @@
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://vyush.gitlab.io/SHbundle.jl/dev)
[![Build Status](https://gitlab.com/vyush/SHbundle.jl/badges/master/pipeline.svg)](https://gitlab.com/vyush/SHbundle.jl/pipelines)
[![Coverage](https://gitlab.com/vyush/SHbundle.jl/badges/master/coverage.svg)](https://gitlab.com/vyush/SHbundle.jl/commits/master)
his package `SHbundle.jl` that contains functions and utilities for spherical harmonics synthesis and analysis.
## Installing Package
You can obtain SHbundle using Julia's Pkg REPL-mode (hitting `]` as the first character of the command prompt):
```julia
(@v1.6) pkg> add "https://gitlab.com/vyush/SHbundle.jl.git"
```
or with
```julia
julia> using Pkg;
julia> Pkg.add(url = "https://gitlab.com/vyush/SHbundle.jl.git")
```
## Importing Package Tools
After installing the package you need to:
```julia
julia> using SHbundle
```
Now you are ready to use the tools provided by package.
```@meta
CurrentModule = SHbundle
DocTestSetup = :(using SHbundle)
```
# SHbundle
Documentation for [SHbundle](https://gitlab.com/vyush/SHbundle.jl).
This package `SHbundle.jl` that contains functions and utilities for spherical harmonics synthesis and analysis.
## Installing Package
You can obtain SHbundle using Julia's Pkg REPL-mode (hitting `]` as the first character of the command prompt):
```julia
(@v1.6) pkg> add "https://gitlab.com/vyush/SHbundle.jl.git"
```
or with
```julia
julia> using Pkg;
julia> Pkg.add(url = "https://gitlab.com/vyush/SHbundle.jl.git")
```
## Importing Package Tools
After installing the package you need to:
```julia
julia> using SHbundle
```
Now you are ready to use the tools provided by package.
```@index
```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment