Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
Trying to get
  • Loading branch information
s-baumann committed Jan 6, 2019
1 parent e21cf92 commit 7f1d78e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# FixedPointAcceleration.jl

| Build | Coverage |
|-------|----------|
| [![Build Status](https://travis-ci.com/s-baumann/FixedPointAcceleration.jl.svg?branch=master)](https://travis-ci.org/s-baumann/FixedPointAcceleration.jl) | [![Coverage Status](https://coveralls.io/repos/github/s-baumann/FixedPointAcceleration.jl/badge.svg?branch=master)](https://coveralls.io/github/s-baumann/FixedPointAcceleration.jl?branch=master)
| Build | Coverage | Documentation |
|-------|----------|---------------|
| [![Build Status](https://travis-ci.com/s-baumann/FixedPointAcceleration.jl.svg?branch=master)](https://travis-ci.org/s-baumann/FixedPointAcceleration.jl) | [![Coverage Status](https://coveralls.io/repos/github/s-baumann/FixedPointAcceleration.jl/badge.svg?branch=master)](https://coveralls.io/github/s-baumann/FixedPointAcceleration.jl?branch=master) | [docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-latest-url]: https://s-baumann.github.io/FixedPointAcceleration.jl/latest |

This package implements similar functionality to https://cran.r-project.org/web/packages/FixedPoint/index.html. The key differences are:
* This package makes use of Julia's type system and is generally typed in a more stable and extendible way. FixedPoint results are always output in a FixedPointResults struct. All algorithms are specified by an enum.
Expand Down
15 changes: 15 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
using Distributions, Documenter, FixedPointAcceleration

makedocs(
format = :html,
sitename = "FixedPointAcceleration",
modules = [FixedPointAcceleration]
)

deploydocs(
repo = "github.com/s-baumann/FixedPointAcceleration.jl.git",
julia = "1.0",
target = "build",
deps = nothing,
make = nothing
)
7 changes: 7 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Installation

```julia
Pkg.add("FixedPointAcceleration")
```

will install this package and its dependencies.

0 comments on commit 7f1d78e

Please sign in to comment.