Skip to content

Commit a03800e

Browse files
committed
add documentation link to README
1 parent 4dd8bc3 commit a03800e

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# StatsLib   [![Mentioned in Awesome Cpp](https://awesome.re/mentioned-badge.svg)](https://github.com/fffaraz/awesome-cpp#math) [![Build Status](https://travis-ci.org/kthohr/stats.svg?branch=master)](https://travis-ci.org/kthohr/stats) [![Coverage Status](https://codecov.io/github/kthohr/stats/coverage.svg?branch=master)](https://codecov.io/github/kthohr/stats?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d6460e046dd5428aac53d28a1ce58401)](https://www.codacy.com/app/kthohr/stats?utm_source=github.com&utm_medium=referral&utm_content=kthohr/stats&utm_campaign=Badge_Grade) [![License](https://img.shields.io/badge/Licence-Apache%202.0-blue.svg)](./LICENSE)
1+
# StatsLib   [![Mentioned in Awesome Cpp](https://awesome.re/mentioned-badge.svg)](https://github.com/fffaraz/awesome-cpp#math) [![Build Status](https://travis-ci.org/kthohr/stats.svg?branch=master)](https://travis-ci.org/kthohr/stats) [![Coverage Status](https://codecov.io/github/kthohr/stats/coverage.svg?branch=master)](https://codecov.io/github/kthohr/stats?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d6460e046dd5428aac53d28a1ce58401)](https://www.codacy.com/app/kthohr/stats?utm_source=github.com&utm_medium=referral&utm_content=kthohr/stats&utm_campaign=Badge_Grade) [![License](https://img.shields.io/badge/Licence-Apache%202.0-blue.svg)](./LICENSE) [![Documentation Status](https://readthedocs.org/projects/statslib/badge/?version=latest)](https://statslib.readthedocs.io/en/latest/?badge=latest)
22

33

44

@@ -19,6 +19,7 @@ Features:
1919
### Contents:
2020
* [Distributions](#distributions)
2121
* [Installation](#installation-and-depdencies)
22+
* [Documentation](#documentation)
2223
* [Jupyter Notebook](#jupyter-notebook)
2324
* [Options](#Options)
2425
* [Syntax and Examples](#syntax-and-examples)
@@ -60,7 +61,15 @@ StatsLib is a header-only library. Simply add the header files to your project u
6061
#include "stats.hpp"
6162
```
6263

63-
The only dependency is the latest version of [GCEM](https://github.com/kthohr/gcem).
64+
The only dependency is the latest version of [GCEM](https://github.com/kthohr/gcem) and a C++11 compatible compiler.
65+
66+
## Documentation
67+
68+
Full documentation is available online:
69+
70+
[![Documentation Status](https://readthedocs.org/projects/statslib/badge/?version=latest)](https://statslib.readthedocs.io/en/latest/?badge=latest)
71+
72+
A PDF version of the documentation is available [here](https://buildmedia.readthedocs.org/media/pdf/statslib/latest/statslib.pdf).
6473

6574
## Jupyter Notebook
6675

0 commit comments

Comments
 (0)