Skip to content

Commit 73a1eb2

Browse files
committed
Update installation instructions
1 parent 569c1f9 commit 73a1eb2

File tree

1 file changed

+40
-12
lines changed

1 file changed

+40
-12
lines changed

README.md

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# LinearInterpolators
22

3-
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md)
4-
[![Build Status](https://travis-ci.org/emmt/LinearInterpolators.jl.svg?branch=master)](https://travis-ci.org/emmt/LinearInterpolators.jl)
5-
[![Coverage Status](https://coveralls.io/repos/emmt/LinearInterpolators.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/emmt/LinearInterpolators.jl?branch=master)
6-
[![codecov.io](http://codecov.io/github/emmt/LinearInterpolators.jl/coverage.svg?branch=master)](http://codecov.io/github/emmt/LinearInterpolators.jl?branch=master)
3+
| **Documentation** | **License** | **Build Status** | **Code Coverage** |
4+
|:--------------------------------|:--------------------------------|:----------------------------------------------------------------|:--------------------------------------------------------------------|
5+
| [![][doc-dev-img]][doc-dev-url] | [![][license-img]][license-url] | [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] | [![][coveralls-img]][coveralls-url] [![][codecov-img]][codecov-url] |
76

87
The **LinearInterpolators** package provides many linear interpolation methods
9-
for [`Julia`](http://julialang.org/). These interpolations are *linear* in the
10-
sense that the result depends linearly on the input.
8+
for [**Julia**][julia-url]. These interpolations are *linear* in the sense
9+
that the result depends linearly on the input.
1110

1211

1312
## Features
@@ -40,16 +39,45 @@ sense that the result depends linearly on the input.
4039
## Installation
4140

4241
[LazyAlgebra](https://github.com/emmt/LazyAlgebra.jl) is a prerequisite for
43-
. To install `LazyAlgebra`, simply do:
42+
LinearInterpolators. See [Documentation of
43+
LazyAlgebra](https://emmt.github.io/LazyAlgebra.jl/dev/install/) for installing
44+
this package.
45+
46+
LinearInterpolators is not yet an [official Julia package][julia-url] so you
47+
have to clone the repository. In Julia, hit the `]` key to switch to the
48+
package manager REPL (you should get a `... pkg>` prompt) and type:
4449

4550
```julia
46-
Pkg.clone("https://github.com/emmt/LazyAlgebra.jl.git")
51+
pkg> add "https://github.com/emmt/LinearInterpolators.jl.git"
4752
```
4853

49-
LinearInterpolators is not yet an
50-
[official Julia package](https://pkg.julialang.org/) so you have to clone the
51-
repository:
54+
if you use HTTPS, or:
5255

5356
```julia
54-
Pkg.clone("https://github.com/emmt/LinearInterpolators.jl.git")
57+
pkg> add "git@github.com:emmt/LinearInterpolators.jl.git"
5558
```
59+
60+
if you use SSH.
61+
62+
[doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
63+
[doc-stable-url]: https://emmt.github.io/LinearInterpolators.jl/stable
64+
65+
[doc-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
66+
[doc-dev-url]: https://emmt.github.io/LinearInterpolators.jl/dev
67+
68+
[license-url]: ./LICENSE.md
69+
[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat
70+
71+
[travis-img]: https://travis-ci.org/emmt/LinearInterpolators.jl.svg?branch=master
72+
[travis-url]: https://travis-ci.org/emmt/LinearInterpolators.jl
73+
74+
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/emmt/LinearInterpolators.jl?branch=master
75+
[appveyor-url]: https://ci.appveyor.com/project/emmt/LinearInterpolators-jl/branch/master
76+
77+
[coveralls-img]: https://coveralls.io/repos/emmt/LinearInterpolators.jl/badge.svg?branch=master&service=github
78+
[coveralls-url]: https://coveralls.io/github/emmt/LinearInterpolators.jl?branch=master
79+
80+
[codecov-img]: http://codecov.io/github/emmt/LinearInterpolators.jl/coverage.svg?branch=master
81+
[codecov-url]: http://codecov.io/github/emmt/LinearInterpolators.jl?branch=master
82+
83+
[julia-url]: https://pkg.julialang.org/

0 commit comments

Comments
 (0)