diff --git a/Cargo.toml b/Cargo.toml index 2664ab4..65706dc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "pfapack" -version = "0.1.0" +version = "0.2.0" edition = "2021" -license-file = "LapackLicense" +license-file = "LICENSE" description = "Rust interface for the pfapack library, a Fortran library to compute Pfaffians." repository = "https://github.com/Duumbo/pfapack-rs/tree/main" readme = "README.md" diff --git a/LapackLicense b/LICENSE similarity index 100% rename from LapackLicense rename to LICENSE diff --git a/README.md b/README.md index 3ab0229..806f924 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # pfapack-rs + +
+ +# pfapack-rs + Rust port of the Fortran library pfapack (arXiv:1102.3440) + +![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white) + +![Build](https://img.shields.io/github/actions/workflow/status/Duumbo/pfapack-rs/rust.yml?color=%23a3d1af&style=for-the-badge) ![release](https://img.shields.io/github/v/tag/Duumbo/pfapack-rs?style=for-the-badge) +![PULLREQUESTS](https://img.shields.io/github/issues-pr-closed/Duumbo/pfapack-rs?color=blue&style=for-the-badge) ![CRATES](https://img.shields.io/crates/v/pfapack?style=for-the-badge) + +
+ +## Table of contents + +[Requirements](#requirements) + +[Installation](#installation) + +[Usage](#usage) + +[TODO](#todo) + +## Requirements + +## Installation + +## Usage + +## TODO + +- [ ] Complete the `README.md` +- [ ] Finish testing +- [x] Document code base diff --git a/pfapack-sys b/pfapack-sys index f7eb1af..a237bd3 160000 --- a/pfapack-sys +++ b/pfapack-sys @@ -1 +1 @@ -Subproject commit f7eb1af7daeb70bb6bac2a92210fc13f6ab39bc3 +Subproject commit a237bd39c4daf4f4b4765260e99530274c8d660e