From b97642bc42d72d75a470d92584a676657584d2db Mon Sep 17 00:00:00 2001 From: Andrew Gibbs <32740541+AndrewGibbs@users.noreply.github.com> Date: Tue, 19 Nov 2024 12:37:53 +0000 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f221b14..5acbe7e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# FractalIntegrals [![Build Status](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://andrewgibbs.github.io/FractalIntegrals.jl/dev/) +# FractalIntegrals.jl [![Build Status](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml?query=branch%3Amain) [![codecov](https://codecov.io/gh/AndrewGibbs/FractalIntegrals.jl/graph/badge.svg?token=Z3JPZANMW5)](https://codecov.io/gh/AndrewGibbs/FractalIntegrals.jl) [![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://andrewgibbs.github.io/FractalIntegrals.jl/dev/) +description -The rewrite of [IFSintegrals](https://github.com/AndrewGibbs/IFSintegrals)... +`FractalIntegrals` is a library of methods and structures for evaluating integrals and solving integral equations posed on fractals. It is a rewrite of [IFSintegrals](https://github.com/AndrewGibbs/IFSintegrals). + +## Installation + +As an official Julia package, `FractalIntegrals` can be installed via the Julia package manager: + +``` +using Pkg +Pkg.install("FractalIntegrals") +``` + +## Documentation and examples + +The current documentation can be found [here](https://andrewgibbs.github.io/FractalIntegrals.jl/dev/). Please note that the documentation is still being written. A better introduction might be the example codes; there are several available [in this repo](https://github.com/AndrewGibbs/FractalIntegrals.jl/tree/main/examples), written in [Jupyter notebook](https://jupyter.org) and [Pluto](https://plutojl.org) formats. + +## Coverage + +![Coverage](https://codecov.io/gh/AndrewGibbs/FractalIntegrals.jl/graphs/icicle.svg?token=Z3JPZANMW5)