Skip to content

Commit

Permalink
Add a brief description to the README
Browse files Browse the repository at this point in the history
Because
* Even though the tutorial is not uploaded, someone may want to install
the package.
  • Loading branch information
pmc4 committed Dec 15, 2023
1 parent 329ca37 commit 0fb8cf3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,14 @@
[![Build Status](https://github.com/pmc4/VectorPlotDigitizer.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/pmc4/VectorPlotDigitizer.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/pmc4/VectorPlotDigitizer.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/pmc4/VectorPlotDigitizer.jl)
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

WIP package. Documentation and tutorials will be upload it in the future, sorry for the inconvenience.

The idea of VectorPlotDigitizer is to be able to digitize the data of plots that are given in a vector format, such as SVG or PDF.

To install it enter Pkg mode in a Julia terminal by writing `]` and write `add VectorPlotDigitizer` or use

```julia
using Pkg
Pkg.add(VectorPlotDigitizer)
```

0 comments on commit 0fb8cf3

Please sign in to comment.