Skip to content

Commit d24f19e

Browse files
authored
Remove out-of-date notes in documentation (#302)
1 parent 43a474a commit d24f19e

File tree

1 file changed

+3
-31
lines changed

1 file changed

+3
-31
lines changed

docs/src/index.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,15 @@
11
# Special Functions
22

3-
This package provides a comprehensive collection of special functions based on the
3+
[`SpecialFunctions.jl`](https://github.com/JuliaMath/SpecialFunctions.jl/edit/master/docs/src/index.md) provides a comprehensive collection of special functions based on the
44
[OpenSpecFun](https://github.com/JuliaLang/openspecfun) and [OpenLibm](https://github.com/JuliaLang/openlibm)
55
libraries.
66

77
## Installation
88

9-
The package is available for Julia versions 0.5 and up. To install it, run
9+
The latest version of the package is available for Julia versions 1.3 and up. To install it, run
1010

1111
```julia
1212
Pkg.add("SpecialFunctions")
1313
```
1414

15-
from the Julia REPL.
16-
17-
## Note
18-
19-
Prior to Julia 0.6, most of these functions were available in Julia's `Base` module.
20-
Because of this, the symbols from this package are not exported on Julia 0.5
21-
to avoid name conflicts.
22-
In this case, the symbols will need to be explicitly imported or called
23-
with the prefix `SpecialFunctions`.
24-
This is not necessary for Julia versions 0.6 and later.
25-
26-
On Julia 0.7, [openspecfun](https://github.com/JuliaLang/openspecfun) is not built as
27-
part of Julia.
28-
Thus for Julia versions 0.7 and later, installing this package downloads openspecfun.
29-
Binaries of openspecfun are available for macOS, Windows, and Linux (glibc >= 2.6).
30-
Other systems will need to build the library from source.
31-
You can force a build from source by setting an environment variable called
32-
`JULIA_SPECIALFUNCTIONS_BUILD_SOURCE` equal to `true` before running `Pkg.build`.
33-
This ensures that the library is built locally from source, even if binaries are
34-
available.
35-
Doing this requires a C compiler (Clang on macOS and FreeBSD, GCC elsewhere) and
36-
gfortran.
37-
If you always want to build this library from source, consider adding
38-
39-
```julia
40-
ENV["JULIA_SPECIALFUNCTIONS_BUILD_SOURCE"] = "true"
41-
```
42-
43-
to your `.juliarc.jl` file.
15+
from the Julia REPL. Earlier versions of `SpecialFunctions.jl` are available also for Julia v0.5-1.2.

0 commit comments

Comments
 (0)